@rechargeapps/storefront-client 0.20.1 → 0.21.0

package/dist/index.d.ts

@@ -264,6 +264,92 @@ interface OrderListParams extends ListParams<OrderSortBy> {
     updated_at_min?: IsoDateString;
 }
 
+interface PaymentDetails {
+    /** Payment_method brand or company powering it. valid for CREDIT_CARD only. */
+    brand?: string;
+    /** Payment_method expiry month. valid for CREDIT_CARD only. */
+    exp_month?: string;
+    /** Payment_method expiry year. valid for CREDIT_CARD only. */
+    exp_year?: string;
+    /** last 4-digits of the identifier. valid for CREDIT_CARD only. */
+    last4?: string;
+    /** email linked to paypal. valid for PAYPAL only. */
+    paypal_email?: string;
+    /** paypal user identifier. valid for PAYPAL only. */
+    paypal_payer_id?: string;
+    /** If a digital wallet. */
+    wallet_type?: string;
+    /** Type of funding for the Payment Method. */
+    funding_type?: string;
+}
+declare type PaymentType = 'CREDIT_CARD' | 'PAYPAL' | 'APPLE_PAY' | 'GOOGLE_PAY' | 'SEPA_DEBIT' | 'IDEAL' | 'SHOP_PAY' | 'PAYPAL_EXPRESS' | 'SOFORT' | 'GIROPAY';
+declare type ProcessorName = 'stripe' | 'braintree' | 'authorize' | 'shopify_payments' | 'mollie' | 'adyen' | 'shopify_app_subscription_billing';
+declare type PaymentMethodStatus = 'not_validated' | 'valid' | 'invalid';
+interface PaymentMethod {
+    /** The unique payment method id for a customer. */
+    id: number;
+    /** An object with the customer’s address information. */
+    billing_address: AssociatedAddress;
+    /** The Recharge customer_id */
+    customer_id: number;
+    /** The time the payment method was created. */
+    created_at: IsoDateString;
+    /** If this is the default payment method for the customer */
+    default: boolean;
+    /** Details about the specific payment method */
+    payment_details: PaymentDetails;
+    /**
+     * The type of payment this is.
+     * If passed, must also be accompanied by one of stripe_customer_token, paypal_customer_token or authorizedotnet_customer_token in processor_payment_method_token.
+     */
+    payment_type: PaymentType;
+    /** The customer token at the processor. */
+    processor_customer_token: string;
+    /**
+     * This will impact validation on billing_details.
+     * Currently, shopify_payments is in read-only mode and can only be managed by Shopify.
+     */
+    processor_name: ProcessorName;
+    /** The payment token at the processor. */
+    processor_payment_method_token: string;
+    /** State of the Payment Method. */
+    status: PaymentMethodStatus;
+    /**
+     * The status reason for the payment method.
+     * Often used when invalid to provide background details in invalidity.
+     */
+    status_reason: string;
+    /** The time the payment method was last updated. */
+    updated_at: IsoDateString;
+    /** Additional information as requested */
+    includes?: {
+        addresses?: Address[];
+    };
+}
+interface PaymentMethodsResponse {
+    next_cursor: null | string;
+    previous_cursor: null | string;
+    payment_methods: PaymentMethod[];
+}
+declare type PaymentMethodOptionalUpdateProps = 'billing_address' | 'default';
+declare type UpdatePaymentMethodRequest = Partial<Pick<PaymentMethod, PaymentMethodOptionalUpdateProps>>;
+declare type PaymentMethodIncludes = 'addresses';
+interface GetPaymentMethodOptions {
+    include?: PaymentMethodIncludes[];
+}
+/** no sorting options for payment_methods, always by id-desc */
+declare type PaymentMethodSortBy = null;
+interface PaymentMethodListParams extends ListParams<PaymentMethodSortBy> {
+    /** Return the payment_methods linked to the given processor_name. */
+    processor_name?: ProcessorName;
+    /** Return the payment_methods linked to the given address_id. */
+    address_id?: string;
+    /** Return the payment_methods linked to the given processor_payment_method_token. */
+    processor_payment_method_token?: string;
+    /** Include related data options */
+    include?: PaymentMethodIncludes[];
+}
+
 declare type ChargeStatus = 'success' | 'error' | 'queued' | 'skipped' | 'refunded' | 'partially_refunded' | 'pending_manual_payment' | 'pending';
 interface Charge {
     /** The unique numeric identifier for the Charge. */
@@ -348,6 +434,10 @@ interface Charge {
     type: 'checkout' | 'recurring';
     /** The date time at which the Charge was most recently updated. */
     updated_at: IsoDateString;
+    /** Additional information as requested */
+    include?: {
+        payment_methods?: PaymentMethod[];
+    };
 }
 interface ChargeResponse {
     charge: Charge;
@@ -357,6 +447,10 @@ interface ChargeListResponse {
     previous_cursor: null | string;
     charges: Charge[];
 }
+declare type ChargeIncludes = 'payment_methods';
+interface GetChargeOptions {
+    include?: ChargeIncludes[];
+}
 declare type ChargeSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc' | 'scheduled_at-asc' | 'scheduled_at-desc';
 interface ChargeListParams extends ListParams<ChargeSortBy> {
     /** Filter Charges by Address. */
@@ -396,167 +490,410 @@ interface ChargeListParams extends ListParams<ChargeSortBy> {
     created_at_min?: IsoDateString;
     /** Show Charges created before the given date. */
     created_at_max?: IsoDateString;
+    /** Include related data options */
+    include?: ChargeIncludes[];
 }
 
-interface CreateAddressRequest {
-    /** Unique numeric identifier for the customer associated with the address. */
+declare type SubscriptionStatus = 'active' | 'cancelled' | 'expired';
+interface Subscription {
+    /** Unique numeric identifier for the subscription. */
+    id: number;
+    /** Unique numeric identifier for the address the subscription is associated with. */
+    address_id: number;
+    /** Unique numeric identifier for the customer the subscription is tied to. */
     customer_id: number;
-    /** The street associated with the Address. Minimum length is 1 character. */
-    address1: string;
-    /** Any additional information associated with the Address. */
-    address2?: string;
-    /** The city associated with the address. */
-    city: string;
-    /** The company associated with the address. */
-    company?: string;
-    /** 2-letter country code. */
-    country_code: string;
-    /** A list of discounts applied on the address. These discounts will apply to future recurring charges associated with this address. */
-    discounts?: Discount[];
-    /** The customer’s first name associated with the address. */
-    first_name: string;
-    /** The customer’s last name associated with the address. */
-    last_name: string;
-    /** Replaces cart_attributes. Extra information that is added to the order. */
-    order_attributes?: Property[];
-    /** Notes to be added to all orders associated with the address. */
-    order_note?: string | null;
-    /** Payment method id for the Payment_method to be associated to this address. */
-    payment_method_id?: number;
-    /** The phone number associated with the address. Must be included in the request schema but can be an empty string. */
-    phone: string;
-    /** The currency on the subscription contract in Shopify. Only set if the currency is different from the store-level currency. Else, will be null. */
-    presentment_currency?: string | null;
-    /** The state or province associated with the address. */
-    province: string | null;
-    /** Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when Charge is created or regenerated */
-    shipping_lines_override?: {
-        code: string;
-        price: string;
-        title: string;
-    }[] | null;
-    /** The zip or postal code associated with the address. */
-    zip: string;
-}
-declare type UpdateAddressRequest = Omit<Partial<CreateAddressRequest>, 'presentment_currency' | 'customer_id' | 'discounts'> & {
-    discounts?: {
-        code: string;
-    }[];
-};
-interface MergeAddressesRequest {
-    /** Indicates whether source addresses should be deleted. */
-    delete_source_addresses?: boolean;
-    /** Specifies the next charge date of the associated subscriptions on the target address. */
-    next_charge_date?: string;
-    /** The address all of the subscriptions should be moved to. */
-    target_address: Address | {
-        id: number;
-    };
-    /** The list of addresses that the subscriptions should move from. */
-    source_addresses: (Address | {
-        id: number;
-    })[];
-}
-interface SkipFutureChargeAddressRequest {
+    /** An object used to contain analytics data such as utm parameters. */
+    analytics_data: AnalyticsData;
+    /** Reason provided for cancellation. */
+    cancellation_reason: string | null;
+    /** Additional comment for cancellation. */
+    cancellation_reason_comments: string | null;
+    /** The time the subscription was cancelled. */
+    cancelled_at: string | null;
     /**
-     * The date in the future of the Charge to be skipped.
-     * This date must be within the delivery schedules of the Customer.
+     * The number of units (specified in order_interval_unit) between each Charge. For example, order_interval_unit=month and charge_interval_frequency=3, indicate charge every 3 months.
+     * Charges must use the same unit types as orders.
+     * Max: 1000
      */
-    date: IsoDateString;
-    /** A list containing the Subscription IDs to be skipped. */
-    subscription_ids: string;
-}
-interface Address {
-    /** Unique numeric identifier for the Address. */
-    id: number;
-    /** The street associated with the Address. */
-    address1: string;
-    /** Any additional information associated with the Address. */
-    address2?: string;
-    /** The city associated with the address. */
-    city: string;
-    /** The company associated with the address. */
-    company: string;
-    /** 2-letter country code. */
-    country_code: string;
-    /** Unique numeric identifier for the customer associated with the address. */
-    customer_id: number;
-    /** A list of discounts applied on the address. These discounts will apply to future recurring charges associated with this address. */
-    discounts: Discount[];
-    /** The customer’s first name associated with the address. */
-    first_name: string;
-    /** The customer’s last name associated with the address. */
-    last_name: string;
-    /** Replaces cart_attributes. Extra information that is added to the order. */
-    order_attributes: Property[];
-    /** Notes to be added to all orders associated with the address. */
-    order_note: string | null;
-    /** Unique numeric identifier for the Payment Method associated to the Address. */
-    payment_method_id: number;
-    /** The phone number associated with the address. */
-    phone: string;
-    /** The currency on the subscription contract in Shopify. Only set if the currency is different from the store-level currency. Else, will be null. */
-    presentment_currency: string | null;
-    /** The state or province associated with the address. */
-    province: string | null;
-    /** Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when Charge is created or regenerated */
-    shipping_lines_override: {
-        code: string;
-        price: string;
-        title: string;
-    }[] | null;
-    /** The zip or postal code associated with the address. */
-    zip?: string | null;
-    /** The date and time when the address was created. */
+    charge_interval_frequency: number;
+    /** The time the subscription was created. */
     created_at: IsoDateString;
-    /** The date and time when the address was last updated. */
-    updated_at: IsoDateString;
-}
-interface SkipFutureChargeAddressResponse {
-    charge: Charge;
-}
-interface AddressResponse {
-    address: Address;
-}
-interface AddressListResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    addresses: Address[];
-}
-declare type AddressSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
-interface AddressListParams extends ListParams<AddressSortBy> {
-    /** Returns addresses that have the provided discount_id. */
-    discount_id?: string;
-    /** Returns addresses that have the provided discount_code. */
-    discount_code?: string;
-    /** Returns addresses created after the given time. */
-    created_at_min?: IsoDateString;
-    /** Returns addresses created before the given time. */
-    created_at_max?: IsoDateString;
-    /** Returns active addresses. */
-    is_active?: boolean;
-}
-
-interface Session {
-    apiToken: string;
-    customerId?: string;
-}
-
-/** Returns all addresses from the store, or addresses for the customer given in the parameter. */
-declare function listAddresses(session: Session, query?: AddressListParams): Promise<AddressListResponse>;
-/** Retrieves address for customer based on specified address id. */
-declare function getAddress(session: Session, id: string | number): Promise<Address>;
-/** Create a new address for a customer. */
-declare function createAddress(session: Session, createRequest: CreateAddressRequest): Promise<Address>;
-/** Updates an existing address to match the specified parameters. */
-declare function updateAddress(session: Session, id: string | number, updateRequest: UpdateAddressRequest): Promise<Address>;
-/** Apply discount code to an address.  Addresses are currently limited to a single discount. */
-declare function applyDiscountToAddress(session: Session, id: string | number, discountCode: string): Promise<Address>;
-/** Removes all discounts from an address. */
-declare function removeDiscountsFromAddress(session: Session, id: string | number): Promise<Address>;
-/** Deletes an address. Only Addresses with no active Subscriptions can be deleted. */
-declare function deleteAddress(session: Session, id: string | number): Promise<void>;
-/**
+    /** Set the number of charges until subscription expires. */
+    expire_after_specific_number_of_charges: number | null;
+    /** An object containing the product id as it appears in external platforms. */
+    external_product_id: ExternalId;
+    /** An object containing the variant id as it appears in external platforms. */
+    external_variant_id: ExternalId;
+    /** Retrieves true if there is queued charge. Otherwise, retrieves false. */
+    has_queued_charges: boolean;
+    /** Value is set to true if it is a prepaid item. */
+    is_prepaid: boolean;
+    /** Value is set to true if it is not a prepaid item */
+    is_skippable: boolean;
+    /** Value is set to true if it is not a prepaid item and if in Customer portal settings swap is allowed for customers. */
+    is_swappable: boolean;
+    /** Retrieves true if charge has an error max retries reached. Otherwise, retrieves false. */
+    max_retries_reached: boolean;
+    /** Date of the next charge for the subscription. */
+    next_charge_scheduled_at: IsoDateString;
+    /**
+     * The set day of the month order is created. Default is that there isn’t a strict day of the month when the order is created.
+     * This is only applicable to subscriptions with order_interval_unit:“month”.
+     */
+    order_day_of_month: number | null;
+    /**
+     * The set day of the week order is created. Default is that there isn’t a strict day of the week order is created.
+     * This is only applicable to subscriptions with order_interval_unit = “week”.
+     * Value of 0 equals to Monday, 1 to Tuesday etc.
+     */
+    order_day_of_week: number | null;
+    /**
+     * The number of units (specified in order_interval_unit) between each order. For example, order_interval_unit=month and order_interval_frequency=3, indicate order every 3 months. Max value: 1000
+     */
+    order_interval_frequency: number;
+    /** The frequency unit used to determine when a subscription’s order is created. */
+    order_interval_unit: IntervalUnit;
+    /** The presentment currency of the subscription. */
+    presentment_currency: string | null;
+    /** The price of the item before discounts, taxes, or shipping have been applied. */
+    price: string;
+    /** The name of the product in a store’s catalog. */
+    product_title: string;
+    /** A list of line item objects, each one containing information about the subscription. Custom key-value pairs can be installed here, they will appear on the connected queued charge and after it is processed on the order itself. */
+    properties: Property[];
+    /** The number of items in the subscription. */
+    quantity: number;
+    /** A unique identifier of the item in the fulfillment. In cases where SKU is blank, it will be dynamically pulled whenever it is used. */
+    sku: string | null;
+    /** Flag that is automatically updated to true when SKU is passed on create or update. When sku_override is true, the SKU on the subscription will be used to generate charges and orders. When sku_override is false, Recharge will dynamically fetch the SKU from the corresponding external platform variant. */
+    sku_override: boolean;
+    /**
+     * The status of the subscription.
+     * expired - This status occurs when the maximum number of charges for a product has been reached.
+     */
+    status: SubscriptionStatus;
+    /** The date time at which the purchase_item record was last updated. */
+    updated_at: IsoDateString;
+    /** The name of the variant in a shop’s catalog. */
+    variant_title: string;
+    /** Additional information as requested */
+    includes?: {
+        address?: Address;
+    };
+}
+interface SubscriptionsResponse {
+    next_cursor: null | string;
+    previous_cursor: null | string;
+    subscriptions: Subscription[];
+}
+declare type SubscriptionIncludes = 'address';
+interface GetSubscriptionOptions {
+    include?: SubscriptionIncludes[];
+}
+declare type SubscriptionSortBy = 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc' | 'updated_at-asc' | 'updated_at-desc';
+interface SubscriptionListParams extends ListParams<SubscriptionSortBy> {
+    /** Return the subscriptions linked to the given address_id. */
+    address_id?: string;
+    /** Return the subscriptions linked to the given address_ids. */
+    address_ids?: string[];
+    /** Return the subscriptions created before the given date. */
+    created_at_max?: IsoDateString;
+    /** Return the subscriptions created after the given date. */
+    created_at_min?: IsoDateString;
+    /** Return the subscriptions linked to the given external_variant_id */
+    external_variant_id?: string;
+    /** Comma-separated list of subscription_ids to filter */
+    ids?: string[];
+    /** Return the subscriptions with specified status. */
+    status?: SubscriptionStatus;
+    /** Return the subscriptions updated before the given date. */
+    updated_at_max?: IsoDateString;
+    /** Return the subscriptions updated after the given date. */
+    updated_at_min?: IsoDateString;
+    /** Include related data options */
+    include?: SubscriptionIncludes[];
+}
+declare type SubscriptionRequiredCreateProps = 'address_id' | 'charge_interval_frequency' | 'external_variant_id' | 'next_charge_scheduled_at' | 'order_interval_frequency' | 'order_interval_unit' | 'quantity';
+declare type SubscriptionOptionalCreateProps = 'expire_after_specific_number_of_charges' | 'order_day_of_month' | 'order_day_of_week' | 'external_product_id' | 'price' | 'product_title' | 'properties' | 'status';
+declare type CreateSubscriptionRequest = SubType<Subscription, SubscriptionRequiredCreateProps, SubscriptionOptionalCreateProps>;
+declare type SubscriptionOptionalUpdateProps = 'charge_interval_frequency' | 'expire_after_specific_number_of_charges' | 'order_day_of_month' | 'order_day_of_week' | 'order_interval_frequency' | 'order_interval_unit' | 'quantity' | 'external_product_id' | 'external_variant_id' | 'properties' | 'sku' | 'sku_override';
+declare type UpdateSubscriptionRequest = Partial<Pick<Subscription, SubscriptionOptionalUpdateProps>>;
+interface UpdateSubscriptionParams {
+    /** Controls whether the QUEUED charges linked to the subscription should be regenerated upon subscription update. By default the flag is set to false which will delay charge regeneration 5 seconds. This enables running multiple calls to perform changes and receive responses much faster since the API won’t wait for a charge regeneration to complete. Setting this parameter to true will cause charge regeneration to complete before returning a response. */
+    commit?: boolean;
+}
+interface CancelSubscriptionRequest {
+    cancellation_reason: string;
+    cancellation_reason_comments?: string;
+    send_email?: boolean;
+}
+
+declare type CustomerIncludes = 'addresses' | 'payment_methods' | 'subscriptions';
+interface GetCustomerOptions {
+    include?: CustomerIncludes[];
+}
+interface Customer {
+    /** Unique numeric identifier for the Customer. */
+    id: number;
+    /** An object containing analytics data associated with the customer. */
+    analytics_data: AnalyticsData;
+    /** The date and time when the customer was created. */
+    created_at: IsoDateString;
+    /** The email address of the customer. */
+    email: string;
+    /** An object containing external ids for the customer record. */
+    external_customer_id: ExternalId;
+    /** Date when first charge was processed for the customer. */
+    first_charge_processed_at: IsoDateString;
+    /** The customer’s first name. */
+    first_name: string;
+    /** A boolean that indicates if the customer has a payment method that is in dunning (failed charge). */
+    has_payment_method_in_dunning: boolean;
+    /** Is the payment method valid or not. */
+    has_valid_payment_method: boolean;
+    /** The unique string identifier used in a customers portal link. */
+    hash: string;
+    /** The customer’s last name. */
+    last_name: string;
+    /** The number of active subscriptions on addresses associated with the customer. */
+    subscriptions_active_count: number;
+    /** The total number of subscriptions created on addresses associated with the customer. */
+    subscriptions_total_count: number;
+    /** The date and time when the customer was last updated. */
+    updated_at: IsoDateString;
+    /** Additional information as requested */
+    include?: {
+        addresses?: Address[];
+        payment_methods?: PaymentMethod[];
+        subscriptions?: Subscription[];
+    };
+}
+declare type CustomerOptionalUpdateProps = 'email' | 'first_name' | 'last_name' | 'external_customer_id';
+declare type UpdateCustomerRequest = Partial<Pick<Customer, CustomerOptionalUpdateProps>>;
+interface CustomerDeliveryScheduleParams {
+    delivery_count_future?: number;
+    future_internal?: number;
+    date_max?: IsoDateString;
+}
+declare type DeliveryLineItem = Omit<LineItem, 'external_inventory_policy' | 'grams' | 'handle' | 'purchase_item_id' | 'purchase_item_type' | 'sku' | 'tax_due' | 'tax_lines' | 'taxable_amount' | 'taxable' | 'title' | 'total_price' | 'unit_price_includes_tax'> & {
+    /** Value is set to true if it is not a onetime or a prepaid item */
+    is_skippable: boolean;
+    /** Value is set to true if the order is skipped. */
+    is_skipped: boolean;
+    /** The type of the plan. May return null value in certain cases. */
+    plan_type: 'subscription' | 'onetime';
+    /** Value is set to true if it is a prepaid item */
+    is_prepaid: boolean;
+    /** The name of the product in a store’s catalog. */
+    product_title: string;
+    /** Unique numeric identifier for the subscription linked to this line_item in the order. */
+    subscription_id: number;
+    /** The subtotal price (sum of all line items * their quantity) of the order less discounts. */
+    subtotal_price: string;
+};
+declare type DeliveryPaymentMethod = Omit<PaymentMethod, 'created_at' | 'customer_id' | 'default' | 'payment_type' | 'processor_customer_token' | 'processor_name' | 'processor_payment_method_token' | 'status_reason' | 'status' | 'updated_at'> & {
+    payment_details: PaymentDetails;
+    billing_address: AssociatedAddress;
+};
+interface DeliveryOrder {
+    id: number;
+    address_id: number;
+    charge_id: number;
+    line_items: DeliveryLineItem[];
+    payment_method: DeliveryPaymentMethod;
+    shipping_address: AssociatedAddress;
+    order_subtotal: string;
+    currency: string;
+}
+interface Delivery {
+    date: IsoDateString;
+    orders: DeliveryOrder[];
+}
+interface CustomerDeliveryScheduleResponse {
+    customer: {
+        id: number;
+        email: string;
+        first_name: string;
+        last_name: string;
+    };
+    deliveries: Delivery[];
+}
+
+interface CreateAddressRequest {
+    /** Unique numeric identifier for the customer associated with the address. */
+    customer_id: number;
+    /** The street associated with the Address. Minimum length is 1 character. */
+    address1: string;
+    /** Any additional information associated with the Address. */
+    address2?: string;
+    /** The city associated with the address. */
+    city: string;
+    /** The company associated with the address. */
+    company?: string;
+    /** 2-letter country code. */
+    country_code: string;
+    /** A list of discounts applied on the address. These discounts will apply to future recurring charges associated with this address. */
+    discounts?: {
+        id: number;
+    }[];
+    /** The customer’s first name associated with the address. */
+    first_name: string;
+    /** The customer’s last name associated with the address. */
+    last_name: string;
+    /** Replaces cart_attributes. Extra information that is added to the order. */
+    order_attributes?: Property[];
+    /** Notes to be added to all orders associated with the address. */
+    order_note?: string | null;
+    /** Payment method id for the Payment_method to be associated to this address. */
+    payment_method_id?: number;
+    /** The phone number associated with the address. Must be included in the request schema but can be an empty string. */
+    phone: string;
+    /** The currency on the subscription contract in Shopify. Only set if the currency is different from the store-level currency. Else, will be null. */
+    presentment_currency?: string | null;
+    /** The state or province associated with the address. */
+    province: string | null;
+    /** Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when Charge is created or regenerated */
+    shipping_lines_override?: {
+        code: string;
+        price: string;
+        title: string;
+    }[] | null;
+    /** The zip or postal code associated with the address. */
+    zip: string;
+}
+declare type UpdateAddressRequest = Omit<Partial<CreateAddressRequest>, 'presentment_currency' | 'customer_id' | 'discounts'> & {
+    discounts?: {
+        code: string;
+    }[];
+};
+interface MergeAddressesRequest {
+    /** Indicates whether source addresses should be deleted. */
+    delete_source_addresses?: boolean;
+    /** Specifies the next charge date of the associated subscriptions on the target address. */
+    next_charge_date?: string;
+    /** The address all of the subscriptions should be moved to. */
+    target_address: Address | {
+        id: number;
+    };
+    /** The list of addresses that the subscriptions should move from. */
+    source_addresses: (Address | {
+        id: number;
+    })[];
+}
+interface SkipFutureChargeAddressRequest {
+    /**
+     * The date in the future of the Charge to be skipped.
+     * This date must be within the delivery schedules of the Customer.
+     */
+    date: IsoDateString;
+    /** A list containing the Subscription IDs to be skipped. */
+    subscription_ids: string;
+}
+interface Address {
+    /** Unique numeric identifier for the Address. */
+    id: number;
+    /** The street associated with the Address. */
+    address1: string;
+    /** Any additional information associated with the Address. */
+    address2?: string;
+    /** The city associated with the address. */
+    city: string;
+    /** The company associated with the address. */
+    company: string;
+    /** 2-letter country code. */
+    country_code: string;
+    /** Unique numeric identifier for the customer associated with the address. */
+    customer_id: number;
+    /** A list of discounts applied on the address. These discounts will apply to future recurring charges associated with this address. */
+    discounts: {
+        id: number;
+    }[];
+    /** The customer’s first name associated with the address. */
+    first_name: string;
+    /** The customer’s last name associated with the address. */
+    last_name: string;
+    /** Replaces cart_attributes. Extra information that is added to the order. */
+    order_attributes: Property[];
+    /** Notes to be added to all orders associated with the address. */
+    order_note: string | null;
+    /** Unique numeric identifier for the Payment Method associated to the Address. */
+    payment_method_id: number;
+    /** The phone number associated with the address. */
+    phone: string;
+    /** The currency on the subscription contract in Shopify. Only set if the currency is different from the store-level currency. Else, will be null. */
+    presentment_currency: string | null;
+    /** The state or province associated with the address. */
+    province: string | null;
+    /** Used when shipping rates need to be overridden. If this parameter has value null, rates will be fetched when Charge is created or regenerated */
+    shipping_lines_override: {
+        code: string;
+        price: string;
+        title: string;
+    }[] | null;
+    /** The zip or postal code associated with the address. */
+    zip?: string | null;
+    /** The date and time when the address was created. */
+    created_at: IsoDateString;
+    /** The date and time when the address was last updated. */
+    updated_at: IsoDateString;
+    /** Additional information as requested */
+    include?: {
+        customer?: Customer;
+        payment_methods?: PaymentMethod[];
+        subscriptions?: Subscription[];
+    };
+}
+interface SkipFutureChargeAddressResponse {
+    charge: Charge;
+}
+interface AddressResponse {
+    address: Address;
+}
+interface AddressListResponse {
+    next_cursor: null | string;
+    previous_cursor: null | string;
+    addresses: Address[];
+}
+declare type AddressIncludes = 'customer' | 'payment_methods' | 'subscriptions';
+interface GetAddressOptions {
+    include?: AddressIncludes[];
+}
+declare type AddressSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc';
+interface AddressListParams extends ListParams<AddressSortBy> {
+    /** Returns addresses that have the provided discount_id. */
+    discount_id?: string;
+    /** Returns addresses that have the provided discount_code. */
+    discount_code?: string;
+    /** Returns addresses created after the given time. */
+    created_at_min?: IsoDateString;
+    /** Returns addresses created before the given time. */
+    created_at_max?: IsoDateString;
+    /** Returns active addresses. */
+    is_active?: boolean;
+    /** Include related data options */
+    include?: AddressIncludes[];
+}
+
+interface Session {
+    apiToken: string;
+    customerId?: string;
+}
+
+/** Returns all addresses from the store, or addresses for the customer given in the parameter. */
+declare function listAddresses(session: Session, query?: AddressListParams): Promise<AddressListResponse>;
+/** Retrieves address for customer based on specified address id. */
+declare function getAddress(session: Session, id: string | number, options?: GetAddressOptions): Promise<Address>;
+/** Create a new address for a customer. */
+declare function createAddress(session: Session, createRequest: CreateAddressRequest): Promise<Address>;
+/** Updates an existing address to match the specified parameters. */
+declare function updateAddress(session: Session, id: string | number, updateRequest: UpdateAddressRequest): Promise<Address>;
+/** Apply discount code to an address.  Addresses are currently limited to a single discount. */
+declare function applyDiscountToAddress(session: Session, id: string | number, discountCode: string): Promise<Address>;
+/** Removes all discounts from an address. */
+declare function removeDiscountsFromAddress(session: Session, id: string | number): Promise<Address>;
+/** Deletes an address. Only Addresses with no active Subscriptions can be deleted. */
+declare function deleteAddress(session: Session, id: string | number): Promise<void>;
+/**
  * Merges up to 10 source addresses into 1 target address.
  */
 declare function mergeAddresses(session: Session, mergeRequest: MergeAddressesRequest): Promise<Address>;
@@ -568,7 +905,7 @@ declare function skipFutureCharge(session: Session, id: string | number, skipReq
 declare function loginShopifyAppProxy(): Promise<Session>;
 declare function loginShopifyApi(shopifyStorefrontToken: string, shopifyCustomerAccessToken?: string): Promise<Session | null>;
 
-declare function getCharge(session: Session, id: number | string): Promise<Charge>;
+declare function getCharge(session: Session, id: number | string, options?: GetChargeOptions): Promise<Charge>;
 /** Lists charges */
 declare function listCharges(session: Session, query?: ChargeListParams): Promise<ChargeListResponse>;
 /**
@@ -750,539 +1087,248 @@ interface CDNProductsAndSettingsResource {
     widget_settings: CDNWidgetSettingsRaw;
     store_settings?: CDNStoreSettings;
     meta?: {
-        status: string;
-        message: string;
-    };
-}
-interface CDNSellingPlan {
-    order_interval_frequency: string | number;
-    created_at?: IsoDateString;
-    order_interval_unit_type: IntervalUnit;
-    updated_at?: IsoDateString;
-    id: number;
-    selling_plan_id: number;
-    selling_plan_name: string;
-    price_adjustments_value_type: PriceAdjustmentsType;
-    price_adjustments_value: number;
-}
-interface CDNSellingPlanGroup {
-    selling_plan_group_id: string | number;
-    selling_plans: CDNSellingPlan[];
-    subscription_product_id: number;
-}
-interface CDNSubscriptionOption {
-    storefront_purchase_options: StorefrontPurchaseOption;
-    updated_at: IsoDateString;
-    is_prepaid?: boolean;
-}
-interface CDNSellingPlanAllocations {
-    selling_plan_group_id: string | number;
-    selling_plan_id: number;
-    discounted_price: string;
-}
-interface CDNPrices {
-    compare_at_price: string | null;
-    unit_price: string;
-    discounted_price: string;
-    zero_decimal_currency: boolean;
-}
-interface CDNVariantOptionValue {
-    id: number;
-    label: string;
-}
-interface CDNVariant {
-    id: number;
-    option_values: CDNVariantOptionValue[];
-    prices: CDNPrices;
-    selling_plan_allocations: CDNSellingPlanAllocations[];
-}
-interface CDNProductOptionValue {
-    id?: number | null;
-    label: string;
-    position: number;
-}
-interface CDNProductOption {
-    id: number;
-    name: string;
-    position: number;
-    values: CDNProductOptionValue[];
-}
-interface CDNProductRaw {
-    id: number | null;
-    bundle_product?: CDNBundleSettings | null;
-    external_product_id: number;
-    in_recharge: boolean;
-    options: CDNProductOption[];
-    variants: CDNVariant[];
-    subscription_options: CDNSubscriptionOption;
-    selling_plan_groups: CDNSellingPlanGroup[];
-}
-interface CDNProduct extends CDNProductRaw {
-    /** @deprecated */
-    isSubscriptionOnly: boolean;
-    is_subscription_only: boolean;
-}
-interface CDNProductAndSettings {
-    product: CDNProduct;
-    widget_settings: CDNWidgetSettings;
-    store_settings: CDNStoreSettings;
-    /** @deprecated */
-    widgetSettings: CDNWidgetSettings;
-    /** @deprecated */
-    storeSettings: CDNStoreSettings;
-}
-interface CDNProductsAndSettings {
-    products: CDNProductKeyObject[];
-    widget_settings: CDNWidgetSettings;
-    store_settings: Partial<CDNStoreSettings>;
-}
-interface CDNBaseWidgetSettings {
-    active_color: ColorString;
-    auto_inject?: boolean;
-    background_color: ColorString;
-    bundle_translations?: BundleTranslations;
-    delivery_dropdown_label: string;
-    display_on: string[];
-    first_option: FirstOption;
-    font_color: ColorString;
-    form_type: string;
-    how_it_works: HTMLString;
-    learnmore_url: string;
-    learnmore_verbiage: string;
-    onetime_message: string;
-    popup_background_color: ColorString;
-    popup_link_color: ColorString;
-    popup_text_color: ColorString;
-    poweredby_url: string;
-    published: boolean;
-    select_subscription_first: boolean;
-    show_learnmore: boolean;
-    show_poweredby: boolean;
-    show_subscription_details: boolean;
-    show_subscription_details_icon: boolean;
-    sub_and_save_ext_label: string;
-    subscribe_message: string;
-    subscribe_without_discount_message: string;
-    subscription_details_verbiage: string;
-    translations: Translations;
-    /** Whether or not plans data will be used on the widget */
-    use_plans_data?: boolean;
-    widget_charge_every: string;
-    widget_deliver_every: string;
-    widget_icon: WidgetIconColor;
-    widget_template_type: WidgetTemplateType;
-}
-declare type CDNExcludedWidgetSettings = 'display_on' | 'first_option';
-interface CDNWidgetSettings extends Omit<CDNBaseWidgetSettings, CDNExcludedWidgetSettings> {
-    /** @deprecated */
-    autoInject: boolean;
-    /** @deprecated */
-    validPages: string[];
-    /** @deprecated */
-    isSubscriptionFirst: boolean;
-    auto_inject: boolean;
-    valid_pages: string[];
-    is_subscription_first: boolean;
-}
-declare type CDNWidgetSettingsRaw = {
-    [key in keyof CDNBaseWidgetSettings]: string;
-};
-interface CDNWidgetSettingsResource {
-    widget_settings: CDNWidgetSettingsRaw;
-    meta: {
-        version: string;
-    };
-}
-interface CDNStoreSettings {
-    store_currency: {
-        currency_code: string;
-        currency_symbol: string;
-        decimal_separator: string;
-        thousands_separator: string;
-        currency_symbol_location: string;
-        zero_decimal_currency?: boolean;
-    };
-}
-/****************** 2021-08 **********************/
-/**************** Bundles ****************/
-interface CDNBundleStepOption {
-    content: string;
-    defaultImage: string;
-}
-interface CDNBundleStep {
-    data?: {
-        optionsMeta: {
-            [key: string]: CDNBundleStepOption;
-        };
-    };
-    disable: boolean;
-    index: string;
-    name: string;
-    title: string;
-    type: 'variantSelector' | 'all-collections' | 'addons' | 'summary' | 'cross-sells';
-}
-interface CDNBundleLayoutSettings {
-    addToCartCallback: {
-        type: 'none';
-        value: string;
-    };
-    addons: {
-        collectionHandle: string;
-        collectionId: string;
-        enabled: boolean;
-    };
-    collapsibleSections: boolean;
-    crossSells: {
-        collectionId: string;
-        enabled: boolean;
-        collectionHandle: string;
-    };
-    defaultFrequency: string;
-    defaultVariantId: string;
-    description: string;
-    filters: any[];
-    learnMoreModal: boolean;
-    published: boolean;
-    showVariants: boolean;
-    template: 'one-page' | 'multi-step';
-    templateSettings: {
-        onePage: {
-            frequencySelector: 'dropdown';
-        };
-        multiStep?: {
-            steps: CDNBundleStep[];
-            optionImages: string;
-        };
-    };
-    title: string;
-    visibility: {
-        portal: boolean;
-        signup: boolean;
+        status: string;
+        message: string;
     };
 }
-interface CDNBundleVariantOptionSource {
+interface CDNSellingPlan {
+    order_interval_frequency: string | number;
+    created_at?: IsoDateString;
+    order_interval_unit_type: IntervalUnit;
+    updated_at?: IsoDateString;
     id: number;
-    collection_id: string;
-    quantity_max: number | null;
-    quantity_min: number | null;
+    selling_plan_id: number;
+    selling_plan_name: string;
+    price_adjustments_value_type: PriceAdjustmentsType;
+    price_adjustments_value: number;
 }
-interface CDNBundleVariantSelectionDefault {
-    id: number;
-    quantity: number;
-    external_variant_id: string;
+interface CDNSellingPlanGroup {
+    selling_plan_group_id: string | number;
+    selling_plans: CDNSellingPlan[];
+    subscription_product_id: number;
 }
-interface CDNBundleVariant {
-    enabled: boolean;
-    external_variant_id: string;
+interface CDNSubscriptionOption {
+    storefront_purchase_options: StorefrontPurchaseOption;
+    updated_at: IsoDateString;
+    is_prepaid?: boolean;
+}
+interface CDNSellingPlanAllocations {
+    selling_plan_group_id: string | number;
+    selling_plan_id: number;
+    discounted_price: string;
+}
+interface CDNPrices {
+    compare_at_price: string | null;
+    unit_price: string;
+    discounted_price: string;
+    zero_decimal_currency: boolean;
+}
+interface CDNVariantOptionValue {
     id: number;
-    items_count: number;
-    option_sources: CDNBundleVariantOptionSource[];
-    selection_defaults?: CDNBundleVariantSelectionDefault[];
+    label: string;
 }
-interface CDNBundleSettings {
-    customization_window_disabled_message: string | null;
-    customization_window?: number;
-    default_bundle_variant_id?: number;
-    description: string | null;
-    external_product_id: string;
+interface CDNVariant {
     id: number;
-    is_customizable?: boolean;
-    layout_settings: CDNBundleLayoutSettings;
-    layout_settings_version: '2021-11';
-    max_quantity_per_variant: number | null;
-    reset_box_contents?: boolean;
-    variants: CDNBundleVariant[];
+    option_values: CDNVariantOptionValue[];
+    prices: CDNPrices;
+    selling_plan_allocations: CDNSellingPlanAllocations[];
 }
-
-interface PaymentDetails {
-    /** Payment_method brand or company powering it. valid for CREDIT_CARD only. */
-    brand?: string;
-    /** Payment_method expiry month. valid for CREDIT_CARD only. */
-    exp_month?: string;
-    /** Payment_method expiry year. valid for CREDIT_CARD only. */
-    exp_year?: string;
-    /** last 4-digits of the identifier. valid for CREDIT_CARD only. */
-    last4?: string;
-    /** email linked to paypal. valid for PAYPAL only. */
-    paypal_email?: string;
-    /** paypal user identifier. valid for PAYPAL only. */
-    paypal_payer_id?: string;
-    /** If a digital wallet. */
-    wallet_type?: string;
-    /** Type of funding for the Payment Method. */
-    funding_type?: string;
+interface CDNProductOptionValue {
+    id?: number | null;
+    label: string;
+    position: number;
 }
-declare type PaymentType = 'CREDIT_CARD' | 'PAYPAL' | 'APPLE_PAY' | 'GOOGLE_PAY' | 'SEPA_DEBIT';
-declare type ProcessorName = 'stripe' | 'braintree' | 'authorize' | 'shopify_payments' | 'mollie';
-declare type PaymentMethodStatus = 'not_validated' | 'valid' | 'invalid';
-interface PaymentMethod {
-    /** The unique payment method id for a customer. */
+interface CDNProductOption {
     id: number;
-    /** An object with the customer’s address information. */
-    billing_address: AssociatedAddress;
-    /** The Recharge customer_id */
-    customer_id: number;
-    /** The time the payment method was created. */
-    created_at: IsoDateString;
-    /** If this is the default payment method for the customer */
-    default: boolean;
-    /** Details about the specific payment method */
-    payment_details: PaymentDetails;
-    /**
-     * The type of payment this is.
-     * If passed, must also be accompanied by one of stripe_customer_token, paypal_customer_token or authorizedotnet_customer_token in processor_payment_method_token.
-     */
-    payment_type: PaymentType;
-    /** The customer token at the processor. */
-    processor_customer_token: string;
-    /**
-     * This will impact validation on billing_details.
-     * Currently, shopify_payments is in read-only mode and can only be managed by Shopify.
-     */
-    processor_name: ProcessorName;
-    /** The payment token at the processor. */
-    processor_payment_method_token: string;
-    /** State of the Payment Method. */
-    status: PaymentMethodStatus;
-    /**
-     * The status reason for the payment method.
-     * Often used when invalid to provide background details in invalidity.
-     */
-    status_reason: string;
-    /** The time the payment method was last updated. */
-    updated_at: IsoDateString;
+    name: string;
+    position: number;
+    values: CDNProductOptionValue[];
 }
-interface PaymentMethodsResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    payment_methods: PaymentMethod[];
+interface CDNProductRaw {
+    id: number | null;
+    bundle_product?: CDNBundleSettings | null;
+    external_product_id: number;
+    in_recharge: boolean;
+    options: CDNProductOption[];
+    variants: CDNVariant[];
+    subscription_options: CDNSubscriptionOption;
+    selling_plan_groups: CDNSellingPlanGroup[];
 }
-declare type PaymentMethodOptionalUpdateProps = 'billing_address' | 'default';
-declare type UpdatePaymentMethodRequest = Partial<Pick<PaymentMethod, PaymentMethodOptionalUpdateProps>>;
-/** no sorting options for payment_methods, always by id-desc */
-declare type PaymentMethodSortBy = null;
-interface PaymentMethodListParams extends ListParams<PaymentMethodSortBy> {
-    /** Return the payment_methods linked to the given processor_name. */
-    processor_name?: ProcessorName;
-    /** Return the payment_methods linked to the given address_id. */
-    address_id?: string;
-    /** Return the payment_methods linked to the given processor_payment_method_token. */
-    processor_payment_method_token?: string;
+interface CDNProduct extends CDNProductRaw {
+    /** @deprecated */
+    isSubscriptionOnly: boolean;
+    is_subscription_only: boolean;
 }
-
-declare type SubscriptionStatus = 'active' | 'cancelled' | 'expired';
-interface Subscription {
-    /** Unique numeric identifier for the subscription. */
-    id: number;
-    /** Unique numeric identifier for the address the subscription is associated with. */
-    address_id: number;
-    /** Unique numeric identifier for the customer the subscription is tied to. */
-    customer_id: number;
-    /** An object used to contain analytics data such as utm parameters. */
-    analytics_data: AnalyticsData;
-    /** Reason provided for cancellation. */
-    cancellation_reason: string | null;
-    /** Additional comment for cancellation. */
-    cancellation_reason_comments: string | null;
-    /** The time the subscription was cancelled. */
-    cancelled_at: string | null;
-    /**
-     * The number of units (specified in order_interval_unit) between each Charge. For example, order_interval_unit=month and charge_interval_frequency=3, indicate charge every 3 months.
-     * Charges must use the same unit types as orders.
-     * Max: 1000
-     */
-    charge_interval_frequency: number;
-    /** The time the subscription was created. */
-    created_at: IsoDateString;
-    /** Set the number of charges until subscription expires. */
-    expire_after_specific_number_of_charges: number | null;
-    /** An object containing the product id as it appears in external platforms. */
-    external_product_id: ExternalId;
-    /** An object containing the variant id as it appears in external platforms. */
-    external_variant_id: ExternalId;
-    /** Retrieves true if there is queued charge. Otherwise, retrieves false. */
-    has_queued_charges: boolean;
-    /** Value is set to true if it is a prepaid item. */
-    is_prepaid: boolean;
-    /** Value is set to true if it is not a prepaid item */
-    is_skippable: boolean;
-    /** Value is set to true if it is not a prepaid item and if in Customer portal settings swap is allowed for customers. */
-    is_swappable: boolean;
-    /** Retrieves true if charge has an error max retries reached. Otherwise, retrieves false. */
-    max_retries_reached: boolean;
-    /** Date of the next charge for the subscription. */
-    next_charge_scheduled_at: IsoDateString;
-    /**
-     * The set day of the month order is created. Default is that there isn’t a strict day of the month when the order is created.
-     * This is only applicable to subscriptions with order_interval_unit:“month”.
-     */
-    order_day_of_month: number | null;
-    /**
-     * The set day of the week order is created. Default is that there isn’t a strict day of the week order is created.
-     * This is only applicable to subscriptions with order_interval_unit = “week”.
-     * Value of 0 equals to Monday, 1 to Tuesday etc.
-     */
-    order_day_of_week: number | null;
-    /**
-     * The number of units (specified in order_interval_unit) between each order. For example, order_interval_unit=month and order_interval_frequency=3, indicate order every 3 months. Max value: 1000
-     */
-    order_interval_frequency: number;
-    /** The frequency unit used to determine when a subscription’s order is created. */
-    order_interval_unit: IntervalUnit;
-    /** The presentment currency of the subscription. */
-    presentment_currency: string | null;
-    /** The price of the item before discounts, taxes, or shipping have been applied. */
-    price: string;
-    /** The name of the product in a store’s catalog. */
-    product_title: string;
-    /** A list of line item objects, each one containing information about the subscription. Custom key-value pairs can be installed here, they will appear on the connected queued charge and after it is processed on the order itself. */
-    properties: Property[];
-    /** The number of items in the subscription. */
-    quantity: number;
-    /** A unique identifier of the item in the fulfillment. In cases where SKU is blank, it will be dynamically pulled whenever it is used. */
-    sku: string | null;
-    /** Flag that is automatically updated to true when SKU is passed on create or update. When sku_override is true, the SKU on the subscription will be used to generate charges and orders. When sku_override is false, Recharge will dynamically fetch the SKU from the corresponding external platform variant. */
-    sku_override: boolean;
-    /**
-     * The status of the subscription.
-     * expired - This status occurs when the maximum number of charges for a product has been reached.
-     */
-    status: SubscriptionStatus;
-    /** The date time at which the purchase_item record was last updated. */
-    updated_at: IsoDateString;
-    /** The name of the variant in a shop’s catalog. */
-    variant_title: string;
+interface CDNProductAndSettings {
+    product: CDNProduct;
+    widget_settings: CDNWidgetSettings;
+    store_settings: CDNStoreSettings;
+    /** @deprecated */
+    widgetSettings: CDNWidgetSettings;
+    /** @deprecated */
+    storeSettings: CDNStoreSettings;
+}
+interface CDNProductsAndSettings {
+    products: CDNProductKeyObject[];
+    widget_settings: CDNWidgetSettings;
+    store_settings: Partial<CDNStoreSettings>;
+}
+interface CDNBaseWidgetSettings {
+    active_color: ColorString;
+    auto_inject?: boolean;
+    background_color: ColorString;
+    bundle_translations?: BundleTranslations;
+    delivery_dropdown_label: string;
+    display_on: string[];
+    first_option: FirstOption;
+    font_color: ColorString;
+    form_type: string;
+    how_it_works: HTMLString;
+    learnmore_url: string;
+    learnmore_verbiage: string;
+    onetime_message: string;
+    popup_background_color: ColorString;
+    popup_link_color: ColorString;
+    popup_text_color: ColorString;
+    poweredby_url: string;
+    published: boolean;
+    select_subscription_first: boolean;
+    show_learnmore: boolean;
+    show_poweredby: boolean;
+    show_subscription_details: boolean;
+    show_subscription_details_icon: boolean;
+    sub_and_save_ext_label: string;
+    subscribe_message: string;
+    subscribe_without_discount_message: string;
+    subscription_details_verbiage: string;
+    translations: Translations;
+    /** Whether or not plans data will be used on the widget */
+    use_plans_data?: boolean;
+    widget_charge_every: string;
+    widget_deliver_every: string;
+    widget_icon: WidgetIconColor;
+    widget_template_type: WidgetTemplateType;
 }
-interface SubscriptionsResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    subscriptions: Subscription[];
+declare type CDNExcludedWidgetSettings = 'display_on' | 'first_option';
+interface CDNWidgetSettings extends Omit<CDNBaseWidgetSettings, CDNExcludedWidgetSettings> {
+    /** @deprecated */
+    autoInject: boolean;
+    /** @deprecated */
+    validPages: string[];
+    /** @deprecated */
+    isSubscriptionFirst: boolean;
+    auto_inject: boolean;
+    valid_pages: string[];
+    is_subscription_first: boolean;
 }
-declare type SubscriptionSortBy = 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc' | 'updated_at-asc' | 'updated_at-desc';
-interface SubscriptionListParams extends ListParams<SubscriptionSortBy> {
-    /** Return the subscriptions linked to the given address_id. */
-    address_id?: string;
-    /** Return the subscriptions linked to the given address_ids. */
-    address_ids?: string[];
-    /** Return the subscriptions created before the given date. */
-    created_at_max?: IsoDateString;
-    /** Return the subscriptions created after the given date. */
-    created_at_min?: IsoDateString;
-    /** Return the subscriptions linked to the given external_variant_id */
-    external_variant_id?: string;
-    /** Comma-separated list of subscription_ids to filter */
-    ids?: string[];
-    /** Return the subscriptions with specified status. */
-    status?: SubscriptionStatus;
-    /** Return the subscriptions updated before the given date. */
-    updated_at_max?: IsoDateString;
-    /** Return the subscriptions updated after the given date. */
-    updated_at_min?: IsoDateString;
+declare type CDNWidgetSettingsRaw = {
+    [key in keyof CDNBaseWidgetSettings]: string;
+};
+interface CDNWidgetSettingsResource {
+    widget_settings: CDNWidgetSettingsRaw;
+    meta: {
+        version: string;
+    };
 }
-declare type SubscriptionRequiredCreateProps = 'address_id' | 'charge_interval_frequency' | 'external_variant_id' | 'next_charge_scheduled_at' | 'order_interval_frequency' | 'order_interval_unit' | 'quantity';
-declare type SubscriptionOptionalCreateProps = 'expire_after_specific_number_of_charges' | 'order_day_of_month' | 'order_day_of_week' | 'external_product_id' | 'price' | 'product_title' | 'properties' | 'status';
-declare type CreateSubscriptionRequest = SubType<Subscription, SubscriptionRequiredCreateProps, SubscriptionOptionalCreateProps>;
-declare type SubscriptionOptionalUpdateProps = 'charge_interval_frequency' | 'expire_after_specific_number_of_charges' | 'order_day_of_month' | 'order_day_of_week' | 'order_interval_frequency' | 'order_interval_unit' | 'quantity' | 'external_product_id' | 'external_variant_id' | 'properties' | 'sku' | 'sku_override';
-declare type UpdateSubscriptionRequest = Partial<Pick<Subscription, SubscriptionOptionalUpdateProps>>;
-interface UpdateSubscriptionParams {
-    /** Controls whether the QUEUED charges linked to the subscription should be regenerated upon subscription update. By default the flag is set to false which will delay charge regeneration 5 seconds. This enables running multiple calls to perform changes and receive responses much faster since the API won’t wait for a charge regeneration to complete. Setting this parameter to true will cause charge regeneration to complete before returning a response. */
-    commit?: boolean;
+interface CDNStoreSettings {
+    store_currency: {
+        currency_code: string;
+        currency_symbol: string;
+        decimal_separator: string;
+        thousands_separator: string;
+        currency_symbol_location: string;
+        zero_decimal_currency?: boolean;
+    };
 }
-interface CancelSubscriptionRequest {
-    cancellation_reason: string;
-    cancellation_reason_comments?: string;
-    send_email?: boolean;
+/****************** 2021-08 **********************/
+/**************** Bundles ****************/
+interface CDNBundleStepOption {
+    content: string;
+    defaultImage: string;
 }
-
-declare type CustomerIncludes = 'addresses' | 'payment_methods' | 'subscriptions';
-interface GetCustomerOptions {
-    include: CustomerIncludes[];
+interface CDNBundleStep {
+    data?: {
+        optionsMeta: {
+            [key: string]: CDNBundleStepOption;
+        };
+    };
+    disable: boolean;
+    index: string;
+    name: string;
+    title: string;
+    type: 'variantSelector' | 'all-collections' | 'addons' | 'summary' | 'cross-sells';
 }
-interface Customer {
-    /** Unique numeric identifier for the Customer. */
-    id: number;
-    /** An object containing analytics data associated with the customer. */
-    analytics_data: AnalyticsData;
-    /** The date and time when the customer was created. */
-    created_at: IsoDateString;
-    /** The email address of the customer. */
-    email: string;
-    /** An object containing external ids for the customer record. */
-    external_customer_id: ExternalId;
-    /** Date when first charge was processed for the customer. */
-    first_charge_processed_at: IsoDateString;
-    /** The customer’s first name. */
-    first_name: string;
-    /** A boolean that indicates if the customer has a payment method that is in dunning (failed charge). */
-    has_payment_method_in_dunning: boolean;
-    /** Is the payment method valid or not. */
-    has_valid_payment_method: boolean;
-    /** The unique string identifier used in a customers portal link. */
-    hash: string;
-    /** The customer’s last name. */
-    last_name: string;
-    /** The number of active subscriptions on addresses associated with the customer. */
-    subscriptions_active_count: number;
-    /** The total number of subscriptions created on addresses associated with the customer. */
-    subscriptions_total_count: number;
-    /** The date and time when the customer was last updated. */
-    updated_at: IsoDateString;
-    /** Additional information as requested */
-    include?: {
-        addresses?: Address[];
-        payment_methods?: PaymentMethod[];
-        subscriptions?: Subscription[];
+interface CDNBundleLayoutSettings {
+    addToCartCallback: {
+        type: 'none';
+        value: string;
+    };
+    addons: {
+        collectionHandle: string;
+        collectionId: string;
+        enabled: boolean;
+    };
+    collapsibleSections: boolean;
+    crossSells: {
+        collectionId: string;
+        enabled: boolean;
+        collectionHandle: string;
+    };
+    defaultFrequency: string;
+    defaultVariantId: string;
+    description: string;
+    filters: any[];
+    learnMoreModal: boolean;
+    published: boolean;
+    showVariants: boolean;
+    template: 'one-page' | 'multi-step';
+    templateSettings: {
+        onePage: {
+            frequencySelector: 'dropdown';
+        };
+        multiStep?: {
+            steps: CDNBundleStep[];
+            optionImages: string;
+        };
+    };
+    title: string;
+    visibility: {
+        portal: boolean;
+        signup: boolean;
     };
 }
-declare type CustomerOptionalUpdateProps = 'email' | 'first_name' | 'last_name' | 'external_customer_id';
-declare type UpdateCustomerRequest = Partial<Pick<Customer, CustomerOptionalUpdateProps>>;
-interface CustomerDeliveryScheduleParams {
-    delivery_count_future?: number;
-    future_internal?: number;
-    date_max?: IsoDateString;
+interface CDNBundleVariantOptionSource {
+    id: number;
+    collection_id: string;
+    quantity_max: number | null;
+    quantity_min: number | null;
 }
-declare type DeliveryLineItem = Omit<LineItem, 'external_inventory_policy' | 'grams' | 'handle' | 'purchase_item_id' | 'purchase_item_type' | 'sku' | 'tax_due' | 'tax_lines' | 'taxable_amount' | 'taxable' | 'title' | 'total_price' | 'unit_price_includes_tax'> & {
-    /** Value is set to true if it is not a onetime or a prepaid item */
-    is_skippable: boolean;
-    /** Value is set to true if the order is skipped. */
-    is_skipped: boolean;
-    /** The type of the plan. May return null value in certain cases. */
-    plan_type: 'subscription' | 'onetime';
-    /** Value is set to true if it is a prepaid item */
-    is_prepaid: boolean;
-    /** The name of the product in a store’s catalog. */
-    product_title: string;
-    /** Unique numeric identifier for the subscription linked to this line_item in the order. */
-    subscription_id: number;
-    /** The subtotal price (sum of all line items * their quantity) of the order less discounts. */
-    subtotal_price: string;
-};
-declare type DeliveryPaymentMethod = Omit<PaymentMethod, 'created_at' | 'customer_id' | 'default' | 'payment_type' | 'processor_customer_token' | 'processor_name' | 'processor_payment_method_token' | 'status_reason' | 'status' | 'updated_at'> & {
-    payment_details: PaymentDetails;
-    billing_address: AssociatedAddress;
-};
-interface DeliveryOrder {
+interface CDNBundleVariantSelectionDefault {
     id: number;
-    address_id: number;
-    charge_id: number;
-    line_items: DeliveryLineItem[];
-    payment_method: DeliveryPaymentMethod;
-    shipping_address: AssociatedAddress;
-    order_subtotal: string;
-    currency: string;
+    quantity: number;
+    external_variant_id: string;
 }
-interface Delivery {
-    date: IsoDateString;
-    orders: DeliveryOrder[];
+interface CDNBundleVariant {
+    enabled: boolean;
+    external_variant_id: string;
+    id: number;
+    items_count: number;
+    option_sources: CDNBundleVariantOptionSource[];
+    selection_defaults?: CDNBundleVariantSelectionDefault[];
 }
-interface CustomerDeliveryScheduleResponse {
-    customer: {
-        id: number;
-        email: string;
-        first_name: string;
-        last_name: string;
-    };
-    deliveries: Delivery[];
+interface CDNBundleSettings {
+    customization_window_disabled_message: string | null;
+    customization_window?: number;
+    default_bundle_variant_id?: number;
+    description: string | null;
+    external_product_id: string;
+    id: number;
+    is_customizable?: boolean;
+    layout_settings: CDNBundleLayoutSettings;
+    layout_settings_version: '2021-11';
+    max_quantity_per_variant: number | null;
+    reset_box_contents?: boolean;
+    variants: CDNBundleVariant[];
 }
 
 /** @internal */
@@ -1562,14 +1608,14 @@ declare function deleteOnetime(session: Session, id: string | number): Promise<v
 declare function getOrder(session: Session, id: string | number): Promise<Order>;
 declare function listOrders(session: Session, query?: OrderListParams): Promise<OrdersResponse>;
 
-declare function getPaymentMethod(session: Session, id: string | number): Promise<PaymentMethod>;
+declare function getPaymentMethod(session: Session, id: string | number, options?: GetPaymentMethodOptions): Promise<PaymentMethod>;
 declare function updatePaymentMethod(session: Session, id: string | number, updateRequest: UpdatePaymentMethodRequest): Promise<PaymentMethod>;
 declare function listPaymentMethods(session: Session, query?: PaymentMethodListParams): Promise<PaymentMethodsResponse>;
 
 declare function getPlan(session: Session, id: string | number): Promise<Plan>;
 declare function listPlans(session: Session, query?: PlanListParams): Promise<PlansResponse>;
 
-declare function getSubscription(session: Session, id: string | number): Promise<Subscription>;
+declare function getSubscription(session: Session, id: string | number, options?: GetSubscriptionOptions): Promise<Subscription>;
 declare function listSubscriptions(session: Session, query?: SubscriptionListParams): Promise<SubscriptionsResponse>;
 /**
  * When creating a subscription via API, order_interval_frequency and charge_interval_frequency values do not necessarily
@@ -1616,4 +1662,4 @@ declare const api: {
 };
 declare function initRecharge(opt?: InitOptions): void;
 
-export { ActivateMembershipRequest, Address, AddressListParams, AddressListResponse, AddressResponse, AddressSortBy, AnalyticsData, AssociatedAddress, Bundle, BundleItem, BundleProperties, BundleSelection, BundleTranslations, CDNBaseWidgetSettings, CDNBundleLayoutSettings, CDNBundleSettings, CDNBundleStep, CDNBundleStepOption, CDNBundleVariant, CDNBundleVariantOptionSource, CDNBundleVariantSelectionDefault, CDNPrices, CDNProduct, CDNProductAndSettings, CDNProductKeyObject, CDNProductOption, CDNProductOptionValue, CDNProductRaw, CDNProductResource, CDNProductsAndSettings, CDNProductsAndSettingsResource, CDNSellingPlan, CDNSellingPlanAllocations, CDNSellingPlanGroup, CDNStoreSettings, CDNSubscriptionOption, CDNVariant, CDNVariantOptionValue, CDNWidgetSettings, CDNWidgetSettingsRaw, CDNWidgetSettingsResource, CRUDRequestOptions, CancelMembershipRequest, CancelSubscriptionRequest, ChannelSettings, Charge, ChargeListParams, ChargeListResponse, ChargeResponse, ChargeSortBy, ChargeStatus, ColorString, CreateAddressRequest, CreateOnetimeRequest, CreateSubscriptionRequest, Customer, CustomerDeliveryScheduleParams, CustomerDeliveryScheduleResponse, CustomerIncludes, CustomerOptionalUpdateProps, Delivery, DeliveryLineItem, DeliveryOrder, DeliveryPaymentMethod, Discount, ExternalId, ExternalTransactionId, FirstOption, GetCustomerOptions, GetRequestOptions, HTMLString, InitOptions, IntervalUnit, IsoDateString, LineItem, ListParams, LoginResponse, Membership, MembershipIncludes, MembershipListParams, MembershipListResponse, MembershipResponse, MembershipStatus, MembershipsSortBy, MergeAddressesRequest, Method, Onetime, OnetimeCreateProps, OnetimeListParams, OnetimeOptionalCreateProps, OnetimeOptionalUpdateProps, OnetimeRequiredCreateProps, OnetimesResponse, OnetimesSortBy, Order, OrderListParams, OrderSortBy, OrderStatus, OrderType, OrdersResponse, PaymentDetails, PaymentMethod, PaymentMethodListParams, PaymentMethodOptionalUpdateProps, PaymentMethodSortBy, PaymentMethodStatus, PaymentMethodsResponse, PaymentType, Plan, PlanListParams, PlanSortBy, PlanType, PlansResponse, PriceAdjustmentsType, ProcessorName, ProductImage, Property, Request, RequestHeaders, RequestOptions, RequestOptionsHeaders, Session, ShippingLine, SkipFutureChargeAddressRequest, SkipFutureChargeAddressResponse, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, SubType, Subscription, SubscriptionListParams, SubscriptionOptionalCreateProps, SubscriptionOptionalUpdateProps, SubscriptionPreferences, SubscriptionRequiredCreateProps, SubscriptionSortBy, SubscriptionStatus, SubscriptionsResponse, TaxLine, Translations, UpdateAddressRequest, UpdateCustomerRequest, UpdateOnetimeRequest, UpdatePaymentMethodRequest, UpdateSubscriptionParams, UpdateSubscriptionRequest, WidgetIconColor, WidgetTemplateType, activateMembership, activateSubscription, api, applyDiscountToAddress, applyDiscountToCharge, cancelMembership, cancelSubscription, createAddress, createOnetime, createSubscription, deleteAddress, deleteOnetime, getAddress, getBundleId, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCustomer, getDeliverySchedule, getDynamicBundleItems, getMembership, getOnetime, getOrder, getPaymentMethod, getPlan, getSubscription, initRecharge, listAddresses, listCharges, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loginShopifyApi, loginShopifyAppProxy, membershipIncludes, mergeAddresses, processCharge, removeDiscountsFromAddress, removeDiscountsFromCharge, resetCDNCache, skipCharge, skipFutureCharge, skipSubscriptionCharge, unskipCharge, updateAddress, updateCustomer, updateOnetime, updatePaymentMethod, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, validateBundle, validateDynamicBundle };
+export { ActivateMembershipRequest, Address, AddressIncludes, AddressListParams, AddressListResponse, AddressResponse, AddressSortBy, AnalyticsData, AssociatedAddress, Bundle, BundleItem, BundleProperties, BundleSelection, BundleTranslations, CDNBaseWidgetSettings, CDNBundleLayoutSettings, CDNBundleSettings, CDNBundleStep, CDNBundleStepOption, CDNBundleVariant, CDNBundleVariantOptionSource, CDNBundleVariantSelectionDefault, CDNPrices, CDNProduct, CDNProductAndSettings, CDNProductKeyObject, CDNProductOption, CDNProductOptionValue, CDNProductRaw, CDNProductResource, CDNProductsAndSettings, CDNProductsAndSettingsResource, CDNSellingPlan, CDNSellingPlanAllocations, CDNSellingPlanGroup, CDNStoreSettings, CDNSubscriptionOption, CDNVariant, CDNVariantOptionValue, CDNWidgetSettings, CDNWidgetSettingsRaw, CDNWidgetSettingsResource, CRUDRequestOptions, CancelMembershipRequest, CancelSubscriptionRequest, ChannelSettings, Charge, ChargeIncludes, ChargeListParams, ChargeListResponse, ChargeResponse, ChargeSortBy, ChargeStatus, ColorString, CreateAddressRequest, CreateOnetimeRequest, CreateSubscriptionRequest, Customer, CustomerDeliveryScheduleParams, CustomerDeliveryScheduleResponse, CustomerIncludes, CustomerOptionalUpdateProps, Delivery, DeliveryLineItem, DeliveryOrder, DeliveryPaymentMethod, Discount, ExternalId, ExternalTransactionId, FirstOption, GetAddressOptions, GetChargeOptions, GetCustomerOptions, GetPaymentMethodOptions, GetRequestOptions, GetSubscriptionOptions, HTMLString, InitOptions, IntervalUnit, IsoDateString, LineItem, ListParams, LoginResponse, Membership, MembershipIncludes, MembershipListParams, MembershipListResponse, MembershipResponse, MembershipStatus, MembershipsSortBy, MergeAddressesRequest, Method, Onetime, OnetimeCreateProps, OnetimeListParams, OnetimeOptionalCreateProps, OnetimeOptionalUpdateProps, OnetimeRequiredCreateProps, OnetimesResponse, OnetimesSortBy, Order, OrderListParams, OrderSortBy, OrderStatus, OrderType, OrdersResponse, PaymentDetails, PaymentMethod, PaymentMethodIncludes, PaymentMethodListParams, PaymentMethodOptionalUpdateProps, PaymentMethodSortBy, PaymentMethodStatus, PaymentMethodsResponse, PaymentType, Plan, PlanListParams, PlanSortBy, PlanType, PlansResponse, PriceAdjustmentsType, ProcessorName, ProductImage, Property, Request, RequestHeaders, RequestOptions, RequestOptionsHeaders, Session, ShippingLine, SkipFutureChargeAddressRequest, SkipFutureChargeAddressResponse, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, SubType, Subscription, SubscriptionIncludes, SubscriptionListParams, SubscriptionOptionalCreateProps, SubscriptionOptionalUpdateProps, SubscriptionPreferences, SubscriptionRequiredCreateProps, SubscriptionSortBy, SubscriptionStatus, SubscriptionsResponse, TaxLine, Translations, UpdateAddressRequest, UpdateCustomerRequest, UpdateOnetimeRequest, UpdatePaymentMethodRequest, UpdateSubscriptionParams, UpdateSubscriptionRequest, WidgetIconColor, WidgetTemplateType, activateMembership, activateSubscription, api, applyDiscountToAddress, applyDiscountToCharge, cancelMembership, cancelSubscription, createAddress, createOnetime, createSubscription, deleteAddress, deleteOnetime, getAddress, getBundleId, getCDNBundleSettings, getCDNProduct, getCDNProductAndSettings, getCDNProducts, getCDNProductsAndSettings, getCDNStoreSettings, getCDNWidgetSettings, getCharge, getCustomer, getDeliverySchedule, getDynamicBundleItems, getMembership, getOnetime, getOrder, getPaymentMethod, getPlan, getSubscription, initRecharge, listAddresses, listCharges, listMemberships, listOnetimes, listOrders, listPaymentMethods, listPlans, listSubscriptions, loginShopifyApi, loginShopifyAppProxy, membershipIncludes, mergeAddresses, processCharge, removeDiscountsFromAddress, removeDiscountsFromCharge, resetCDNCache, skipCharge, skipFutureCharge, skipSubscriptionCharge, unskipCharge, updateAddress, updateCustomer, updateOnetime, updatePaymentMethod, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, validateBundle, validateDynamicBundle };