@rechargeapps/storefront-client 0.20.0 → 0.21.0

package/dist/index.d.ts

@@ -50,7 +50,6 @@ interface ProductImage {
     sort_order?: number;
 }
 interface LineItem {
-    subscription_id?: number;
     /** The Subscription or Onetime ID associated with the line_item. */
     purchase_item_id: number;
     /** An object containing the associated product ID as it appears in the external system. */
@@ -265,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. */
@@ -349,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;
@@ -358,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. */
@@ -384,7 +477,7 @@ interface ChargeListParams extends ListParams<ChargeSortBy> {
     /** Show Charges scheduled to be processed after the given date. */
     scheduled_at_min?: IsoDateString;
     /** Filter charges by status. */
-    status?: ChargeStatus;
+    status?: ChargeStatus[];
     /** Show charges updated before the given date. */
     updated_at_max?: IsoDateString;
     /** Show charges updated after the given date. */
@@ -397,6 +490,233 @@ 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[];
+}
+
+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;
+    /** 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 {
@@ -413,7 +733,9 @@ interface CreateAddressRequest {
     /** 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[];
+    discounts?: {
+        id: number;
+    }[];
     /** The customer’s first name associated with the address. */
     first_name: string;
     /** The customer’s last name associated with the address. */
@@ -483,7 +805,9 @@ interface Address {
     /** 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[];
+    discounts: {
+        id: number;
+    }[];
     /** The customer’s first name associated with the address. */
     first_name: string;
     /** The customer’s last name associated with the address. */
@@ -512,6 +836,12 @@ interface Address {
     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;
@@ -524,6 +854,10 @@ interface AddressListResponse {
     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. */
@@ -536,6 +870,8 @@ interface AddressListParams extends ListParams<AddressSortBy> {
     created_at_max?: IsoDateString;
     /** Returns active addresses. */
     is_active?: boolean;
+    /** Include related data options */
+    include?: AddressIncludes[];
 }
 
 interface Session {
@@ -546,7 +882,7 @@ interface Session {
 /** 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>;
+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. */
@@ -569,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>;
 /**
@@ -995,267 +1331,6 @@ interface CDNBundleSettings {
     variants: CDNBundleVariant[];
 }
 
-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';
-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. */
-    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;
-}
-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>>;
-/** 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;
-}
-
-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 | null;
-    /** 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 SubscriptionsResponse {
-    next_cursor: null | string;
-    previous_cursor: null | string;
-    subscriptions: Subscription[];
-}
-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 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' | '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;
-}
-interface Delivery {
-    date: IsoDateString;
-    orders: Order[];
-}
-interface CustomerDeliveryScheduleResponse {
-    customer: {
-        id: number;
-        email: string;
-        first_name: string;
-        last_name: string;
-    };
-    deliveries: Delivery[];
-}
-
 /** @internal */
 declare type MembershipStatus = 'active' | 'inactive';
 /** @internal */
@@ -1533,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
@@ -1587,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, 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 };