@rechargeapps/storefront-client 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -1,15 +1,440 @@
 declare const login: () => Promise<boolean>;
 declare const logout: () => void;
 
+/** HEXA, RGBA, HSLA */
+declare type ColorString = string;
+/** HTML String */
+declare type HTMLString = string;
+/** ISO 8601 date time, YYYY-MM-DD */
+declare type IsoDateString = string;
+interface Property {
+    name: string;
+    value: string;
+}
+interface ListParams<T> {
+    /** default is 50, max is 250 */
+    limit?: number;
+    /** next or previous cursor returned by previous list call */
+    cursor?: number;
+    /** sort list by option */
+    sort_by?: T;
+}
+interface ExternalId {
+    /** The order ID as it appears in the external e-commerce platform. */
+    ecommerce: string | null;
+}
+interface ExternalTransactionId {
+    /** The ID of the associated transaction in a payment processor system (like Stripe). */
+    payment_processor: number | null;
+}
+interface AssociatedAddress {
+    address1: string;
+    address2: string | null;
+    city: string;
+    company: string | null;
+    country_code: string;
+    country?: string;
+    first_name: string;
+    last_name: string;
+    phone: string | null;
+    province: string;
+    zip: string;
+}
+interface ProductImage {
+    /** The url where a large image file is located. */
+    large?: string;
+    /** The url where a medium image file is located. */
+    medium?: string;
+    /** The url of the original sized product image. */
+    original?: string;
+    /** The url where a small image file is located. */
+    small?: string;
+    /** The sort order in which the x image from the array should appear when displayed. */
+    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. */
+    external_product_id: ExternalId;
+    /** An object containing the associated variant ID as it appears in the external system. */
+    external_variant_id: ExternalId;
+    /** The weight of the item in grams. */
+    grams: number;
+    /** A unique, human-friendly string for the Product. */
+    handle: string | null;
+    /** An object containing URLs of the Product image. */
+    images: ProductImage;
+    /** An array of name value pairs of additional line_item attributes. */
+    properties: Property[];
+    /** An indicator of the type of the purchase item. */
+    purchase_item_type: 'subscription' | 'onetime';
+    /** The quantity of the line_item. */
+    quantity: number;
+    /** The SKU (stock keeping unit) of the Product associated with the line_item. */
+    sku: string | null;
+    /** The total tax due associated with the line_item. */
+    tax_due: string;
+    /** an array containing tax_line objects associated with this line_item. */
+    tax_lines: TaxLine[];
+    /** A boolean indicating if the line_item is taxable or non-taxable. */
+    taxable: boolean;
+    /** The taxable revenue associated with the line_item. */
+    taxable_amount: string;
+    /** The title of the Product of this line_item. */
+    title: string;
+    /** The total price of the line_item including tax. */
+    total_price: string;
+    /** The unit price of the line_item. */
+    unit_price: string;
+    /** A boolean indicator if tax is included in the price of an item. */
+    unit_price_includes_tax: boolean;
+    /** The name of a variant of the Product of this line_item. */
+    variant_title: string | null;
+}
+interface TaxLine {
+    /** The total tax associated with the listed jurisdiction. */
+    price: string;
+    /** The tax rate associated with the listed jurisdiction. */
+    rate: string;
+    /** The title/name of the taxing jurisdiction. */
+    title: string;
+}
+interface Discount {
+    /** The ID of the Discount. */
+    id: string;
+    /** The code of the Discount. */
+    code: string;
+    /** The value of the Discount. */
+    value: number;
+    /** The type of the value of the Discount. */
+    value_type: 'percentage' | 'fixed_amount';
+}
+declare type SubType<T, TRequired extends keyof T = keyof T, TOptional extends keyof T = keyof T> = Required<Pick<T, TRequired>> & Partial<Pick<T, TOptional>>;
+
+interface ShippingLine {
+    /** The code associated with the shipping_line of a Charge. */
+    code: string;
+    /** The price of the shipping_line. */
+    price: string;
+    /** The source of the shipping_line. */
+    source: string;
+    /** The title of the shipping_line. */
+    title: string;
+    /** A boolean indicating if the shipping_line is taxable. */
+    taxable: boolean;
+    /** An array of tax lines associated with the shipping_line. */
+    tax_lines: TaxLine[];
+}
+declare type OrderStatus = 'success' | 'error' | 'queued' | 'cancelled' | 'pending_charge_status';
+declare type OrderType = 'checkout' | 'recurring';
+interface Order {
+    /** The unique numeric identifier for the order. */
+    id: number;
+    /** The id of the associated Address within Recharge. */
+    address_id: number;
+    /** The billing address at the time the order was created. See Addresses for detailed address information. */
+    billing_address: AssociatedAddress;
+    /** An object containing parameters of the Charge. */
+    charge: {
+        /** The id of the charge associated with this order. */
+        id: number;
+        /** An object containing external transaction ids associated with this charge, as they appear in external platforms. */
+        external_transaction_id: ExternalTransactionId;
+    };
+    /** Details of the access method used by the purchase. */
+    client_details: {
+        /** The IP address of the buyer as detected in Checkout. */
+        browser_ip: string;
+        /** The user agent detected during Checkout. */
+        user_agent: string;
+    };
+    /** The date when the order was created. */
+    created_at: IsoDateString;
+    /** The currency of the payment used to create the order. */
+    currency: string;
+    /** Object that contains information about the Customer. */
+    customer: {
+        /** The ID of the associated customer record. */
+        id: number;
+        /** The user email. */
+        email: string;
+        /** An object containing customer information associated with this charge. */
+        external_customer_id: ExternalId;
+        /** The hash of the Customer associated with the Charge. */
+        hash: string;
+    };
+    /** An array of Discounts associated with the Order. */
+    discounts: Discount[];
+    /** The cart token as it appears in an external system. */
+    external_cart_token: string;
+    /** An object containing external order ids. */
+    external_order_id?: ExternalId;
+    /** An object containing the external order numbers. */
+    external_order_number: ExternalId;
+    /** A boolean representing if this Order is generated from a prepaid purchase. */
+    is_prepaid?: boolean;
+    /** A list of line_item objects. */
+    line_items: LineItem[];
+    /** Notes associated with the Order. */
+    note: string;
+    /** An array of name value pairs of note attributes on the Order. */
+    order_attributes: Property[];
+    /** The date time that the associated charge was processed at. */
+    processed_at: IsoDateString | null;
+    /** The date time of when the associated charge is/was scheduled to process. */
+    scheduled_at: IsoDateString;
+    /** The shipping address where the order will be shipped. See Addresses for detailed Address information. */
+    shipping_address: AssociatedAddress;
+    /** An array of shipping lines associated with the order. */
+    shipping_lines: ShippingLine[];
+    /** The status of creating the Order. */
+    status: OrderStatus;
+    /** The subtotal price (sum of all line items * their quantity) of the order less discounts. */
+    subtotal_price: string;
+    /** A comma separated list of tags on the Order. */
+    tags: string;
+    /** An array of tax lines that apply to the Order. */
+    tax_lines: TaxLine[];
+    /** A boolean indicator of the taxability of the Order. */
+    taxable: boolean;
+    /** The total discounted dollar value of the Order. */
+    total_discounts: string;
+    /** The total price of all line items of the Order. */
+    total_line_items_price: string;
+    /** The total amount due of the Order. */
+    total_price: string;
+    /** The total dollar amount of refunds associated with the Order. */
+    total_refunds: string;
+    /** The total tax due associated with the Order. */
+    total_tax: string;
+    /** The total weight of the order in grams. */
+    total_weight_grams: number;
+    /** An indicator of the order’s type. */
+    type: OrderType;
+    /** The date time at which the order was most recently updated. */
+    updated_at: IsoDateString;
+    /** Error information about the order if status is 'error' */
+    error: string | null;
+}
+interface OrdersResponse {
+    next_cursor: null | string;
+    previous_cursor: null | string;
+    orders: Order[];
+}
+declare type OrderSortBy = 'id-asc' | 'id-desc' | 'updated_at-asc' | 'updated_at-desc' | 'processed_at-asc' | 'processed_at-desc' | 'scheduled_at-asc' | 'scheduled_at-desc';
+interface OrderListParams extends ListParams<OrderSortBy> {
+    address_id?: string;
+    charge_id?: string;
+    created_at_min?: IsoDateString;
+    created_at_max?: IsoDateString;
+    customer_id?: string;
+    external_customer_id?: string;
+    ids?: string[];
+    scheduled_at_max?: IsoDateString;
+    scheduled_at_min?: IsoDateString;
+    has_external_order?: string;
+    status?: OrderStatus;
+    type?: OrderType;
+    purchase_item_id?: string;
+    updated_at_max?: IsoDateString;
+    updated_at_min?: IsoDateString;
+}
+
+interface ChargeAnalyticsData {
+    utm_params: {
+        utm_campaign: string;
+        utm_content: string;
+        utm_data_source: string;
+        utm_source: string;
+        utm_medium: string;
+        utm_term: string;
+        utm_timestamp: string;
+    }[];
+}
+declare type ChargeStatus = 'success' | 'error' | 'queued' | 'skipped' | 'refunded' | 'partially_refunded' | 'pending_manual_payment' | 'pending';
+interface Charge {
+    /** The unique numeric identifier for the Charge. */
+    id: number;
+    /** The ID of the shipping Address tied to the Charge.*/
+    address_id: number;
+    /** An object containing analytics data associated with the Charge. */
+    analytics_data: ChargeAnalyticsData;
+    /** All the billing information related to the charge. */
+    billing_address: AssociatedAddress;
+    /** Details of the access method used by the purchaser. */
+    client_details: {
+        /** The IP address of the buyer as detected in Checkout. */
+        browser_ip: string;
+        /** The user agent detected during Checkout. */
+        user_agent: string;
+    };
+    /** The date and time when the transaction was created. */
+    created_at: IsoDateString;
+    /** The code of the currency for this Charge, such as USD. */
+    currency: string;
+    /** An object containing Customer information associated with this Charge. */
+    customer: {
+        /** The ID of the associated customer record. */
+        id: number;
+        /** The user email. */
+        email: string;
+        /** An object containing customer information associated with this charge. */
+        external_customer_id: string;
+        /** The hash of the Customer associated with the Charge. */
+        hash: string;
+    };
+    /** An array of Discounts associated with the Charge. */
+    discounts: Discount[];
+    /** An object containing the associated external order ID. */
+    external_order_id: ExternalId;
+    /** An object containing the associated external transaction ID. */
+    external_transaction_id: ExternalTransactionId;
+    /** A list of line_item objects, each containing information about a distinct purchase item. */
+    line_items: LineItem;
+    /** Notes associated with the Charge. */
+    note: string;
+    /** An array of name-value pairs of order attributes on the Charge. */
+    order_attributes: Property[];
+    /** The number of Orders generated from this Charge (>1 for prepaid Subscriptions). */
+    orders_count: number;
+    /** The payment processor used for this Charge. */
+    payment_processor: string;
+    /** The date and time when the transaction was processed. */
+    processed_at: IsoDateString;
+    /** The date when the next attempt will be placed. */
+    retry_date: IsoDateString;
+    /** The date time of when the Charge is/was scheduled to process. */
+    scheduled_at: IsoDateString;
+    /** The shipping Address of the Charge. */
+    shipping_address: AssociatedAddress;
+    /** An array of shipping lines associated with the Charge. */
+    shipping_lines: ShippingLine[];
+    /** The status of the Charge. */
+    status: ChargeStatus;
+    /** The combined price of all line_items without taxes and shipping. */
+    subtotal_price: string;
+    /** A comma-separated list of tags on the Charge. */
+    tags: string;
+    /** An array of tax lines that apply to the Charge. */
+    tax_lines: TaxLine[];
+    /** A boolean indicator of the taxability of the Charge. */
+    taxable: boolean;
+    /** The sum of the Discounts applied to the Charge. */
+    total_discounts: string;
+    /** The total price of all line items of the Charge. */
+    total_line_items_price: string;
+    /** The sum of all the prices of all the items in the Charge, taxes and discounts included (must be positive). */
+    total_price: string;
+    /** The sum of all refunds that were applied to the Charge. */
+    total_refunds: string;
+    /** The total tax due associated with the Charge. */
+    total_tax: string;
+    /** The total weight of the Charge’s line items in grams. */
+    total_weight_grams: number;
+    /** An indicator of the Charge’s type, either checkout or recurring. */
+    type: 'checkout' | 'recurring';
+    /** The date time at which the Charge was most recently updated. */
+    updated_at: IsoDateString;
+}
+interface ChargeListResponse {
+    next_cursor: null | string;
+    previous_cursor: null | string;
+    charges: Charge[];
+}
+interface ApplyDiscountRequest {
+    /** Code of the Discount you want to apply to a Charge. */
+    discount_code?: string;
+    /** ID of the Discount you want to apply to a Charge. */
+    discount_id?: number;
+}
+interface RefundChargeRequest {
+    /** Amount of money that will be refunded. It can be fully or partially refunded. */
+    amount: string;
+    /** If this parameter has value true, the Charge will be totally refunded. */
+    full_refund?: boolean;
+}
+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. */
+    address_id?: string;
+    /** Filter Charges by Customer. */
+    customer_id?: string;
+    /** List Charges that contain the given discount_id. */
+    discount_id?: string;
+    /** List Charges that contain the given discount_code. */
+    discount_code?: string;
+    /** Filter Charges by the associated order ID in the external e-commerce platform. */
+    external_order_id?: string;
+    /**
+     * Filter Charges by ID.
+     * If passing multiple values, must be comma separated. Non-integer values will result in a 422 error.
+     */
+    ids?: string;
+    /** Filter Charges by a Subscription or Onetime ID. */
+    purchase_item_id?: string;
+    /** Filter Charges by a comma-separated list of Subscription or Onetime IDs. */
+    purchase_item_ids?: string;
+    /** Filter Charges by specific scheduled charge date. */
+    scheduled_at?: IsoDateString;
+    /** Show Charges scheduled to be processed before the given date. */
+    scheduled_at_max?: IsoDateString;
+    /** Show Charges scheduled to be processed after the given date. */
+    scheduled_at_min?: IsoDateString;
+    /** Filter charges by status. */
+    status?: ChargeStatus;
+    /** Show charges updated before the given date. */
+    updated_at_max?: IsoDateString;
+    /** Show charges updated after the given date. */
+    updated_at_min?: IsoDateString;
+    /** Show charges processed after, and including, the given date. */
+    processed_at_max?: IsoDateString;
+    /** Show charges processed before, and including, the given date. */
+    processed_at_min?: IsoDateString;
+    /** Show Charges created after the given date. */
+    created_at_min?: IsoDateString;
+    /** Show Charges created before the given date. */
+    created_at_max?: IsoDateString;
+}
+
+declare function getCharge(id: number | string): Promise<Charge>;
+/** Lists charges */
+declare function listCharges(query?: ChargeListParams): Promise<ChargeListResponse>;
+/**
+ * You cannot add a Discount to an existing queued Charge if the Charge or the associated Address already has one.
+ * You can provide either discount_id or discount_code. If both parameters are passed, the value for discount_id will take precedence.
+ * If a Charge has a Discount and it gets updated, or a regeneration occurs, the Discount will be lost. Regeneration is a process that refreshes the Charge JSON with new data in the case of the Subscription or Address being updated.
+ */
+declare function applyDiscount(id: number | string, request: ApplyDiscountRequest): Promise<Charge>;
+/**
+ * Remove a Discount from a Charge without destroying the Discount.
+ * In most cases the Discount should be removed from the Address. When the Discount is removed from the Address, the Discount is also removed from any future Charges.
+ * If the Discount is on the parent Address, you cannot remove it using charge_id.
+ * When removing your Discount, it is preferable to pass the address_id so that the Discount stays removed if the Charge is regenerated. Only pass charge_id in edge cases in which there are two or more Charges on a parent Address and you only want to remove the Discount from one Charge.
+ * If you pass both parameters, it will remove the Discount from the Address.
+ */
+declare function removeDiscount(id: number | string): Promise<Charge>;
+declare function skipCharge(id: number | string): Promise<Charge>;
+declare function unskipCharge(id: number | string): Promise<Charge>;
+declare function refundCharge(id: number | string, request: RefundChargeRequest): Promise<Charge>;
+/** The charge processing route can be used to process Charges that are in a queued or error status. */
+declare function processCharge(id: number | string): Promise<Charge>;
+/**
+ * If you are leveraging the authorize/capture workflow with Recharge, the charge/{id}/capture_payment endpoint is how to capture the funds of a previously authorized Charge.
+ */
+declare function captureCharge(id: number | string): Promise<Charge>;
+
 declare type Method = 'get' | 'post' | 'put' | 'delete';
 declare type Request = <T>(method: Method, url: string, options?: RequestOptions) => Promise<T>;
 interface GetRequestOptions {
-    id?: string;
+    id?: string | number;
     query?: unknown;
 }
 interface CRUDRequestOptions {
-    id?: string;
+    id?: string | number;
     data?: unknown;
+    query?: unknown;
 }
 /** Custom headers we use within our storefront client */
 interface CustomHeaders {
@@ -34,25 +459,6 @@ interface Bundle {
     selections: BundleSelection[];
 }
 
-/** HEXA, RGBA, HSLA */
-declare type ColorString = string;
-/** HTML String */
-declare type HTMLString = string;
-/** ISO 8601 date time */
-declare type IsoDateString = string;
-interface Properties {
-    name: string;
-    value: string;
-}
-interface ListParams<T> {
-    /** default is 50, max is 250 */
-    limit?: number;
-    /** next or previous cursor returned by previous list call */
-    cursor?: number;
-    /** sort list by option */
-    sort_by?: T;
-}
-
 declare type FirstOption = 'onetime' | 'autodeliver';
 declare type IntervalUnit = 'day' | 'week' | 'month';
 declare type PriceAdjustmentsType = 'percentage';
@@ -422,64 +828,159 @@ declare const resetCache: () => void;
 declare const getBundleId: (bundle: Bundle) => Promise<string>;
 declare const validateBundle: (bundle: Bundle) => Promise<boolean>;
 
-declare enum SubscriptionStatus {
-    Active = "active",
-    Cancelled = "cancelled",
-    Expired = "expired"
-}
-interface CustomerSubscription {
-    is_prepaid: boolean;
-    order_day_of_month: number | null;
-    order_day_of_week: number | null;
-    order_interval_unit: 'day' | 'week' | 'month';
+interface Onetime {
+    /** Unique numeric identifier for the Onetime purchase. */
+    id: number;
+    /** Unique numeric identifier for the address the Onetime Purchase is associated with (cannot be used with next_charge_scheduled_at) */
+    address_id: number;
+    /** The time the Onetime item was first created. */
+    created_at: IsoDateString;
+    /** Unique numeric identifier for the customer the Onetime purchase is tied to. */
+    customer_id: number;
+    /** 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;
+    /** Flag indicating if the the onetime is cancelled. */
+    is_cancelled: boolean;
+    /**
+     * Date of the Onetime purchase execution.
+     * Cannot be used with add_to_next_charge
+     */
+    next_charge_scheduled_at: IsoDateString;
+    /** The price of the item before discounts, taxes, or shipping have been applied. */
+    price: string;
+    /** The name of the product in a shop’s catalog. */
+    product_title: string;
+    /** An array containing key value pairs for any supplementary data. */
+    properties: Property[];
+    /** The number of items in the Onetime purchase. */
+    quantity: number;
+    /** A unique identifier of the item in the fulfillment. */
+    sku: string;
+    /** Flag that is automatically updated to true when SKU is passed on POST or PUT. */
+    sku_override: boolean;
+    /** The time the Onetime purchase was last updated. */
     updated_at: IsoDateString;
+    /** The name of the variant in a shop’s catalog. */
+    variant_title: string;
+    /** Presentment currency */
+    presentment_currency: string | null;
+}
+declare type RequiredCreateProps$1 = 'address_id' | 'external_variant_id' | 'next_charge_scheduled_at' | 'product_title' | 'quantity';
+declare type OptionalCreateProps$1 = 'external_product_id' | 'properties' | 'sku';
+interface CreateProps {
+    /** Instructs to add the Onetime to the next charge scheduled under this Address. */
+    add_to_next_charge?: boolean;
+}
+declare type CreateOnetimeRequest = SubType<Onetime, RequiredCreateProps$1, OptionalCreateProps$1> & CreateProps;
+declare type OptionalUpdateProps$1 = 'address_id' | 'next_charge_scheduled_at' | 'properties' | 'quantity' | 'external_variant_id' | 'sku';
+declare type UpdateOnetimeRequest = Partial<Pick<Onetime, OptionalUpdateProps$1>>;
+interface OnetimesResponse {
+    next_cursor: null | string;
+    previous_cursor: null | string;
+    onetimes: Onetime[];
+}
+declare type OnetimesSortBy = 'id-asc' | 'id-desc' | 'created_at-asc' | 'created_at-desc' | 'updated_at-asc' | 'updated_at-desc';
+declare type OnetimeListParams = ListParams<OnetimesSortBy>;
+
+declare const getOnetime: (id: string | number) => Promise<Onetime>;
+declare const listOnetimes: (query?: OnetimeListParams) => Promise<OnetimesResponse>;
+declare const createOnetime: (data: CreateOnetimeRequest) => Promise<Onetime>;
+declare const updateOnetime: (id: string | number, data: UpdateOnetimeRequest) => Promise<Onetime>;
+declare const deleteOnetime: (id: string | number) => Promise<void>;
+
+declare const getOrder: (id: string | number) => Promise<Order>;
+declare const listOrders: (query?: OrderListParams) => Promise<OrdersResponse>;
+
+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: {
         utm_params: Record<string, unknown>;
     };
+    /** 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;
-    charge_delay: number | 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;
-    customer_id: number;
-    cutoff_day_of_month_before_and_after: number | null;
-    cutoff_day_of_week_before_and_after: number | null;
-    email: string;
+    /** Set the number of charges until subscription expires. */
     expire_after_specific_number_of_charges: number | null;
-    first_charge_date: IsoDateString | 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: 'day' | 'week' | 'month';
+    /** The presentment currency of the subscription. */
     presentment_currency: string | null;
-    properties: Properties[];
+    /** 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;
-    recharge_product_id: number;
-    shopify_product_id: number;
-    shopify_variant_id: 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: 'active' | 'cancelled' | 'expired';
+    /** 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;
-    charge_interval_frequency: number;
-    external_product_id: {
-        ecommerce: string;
-    };
-    external_variant_id: {
-        ecommerce: string;
-    };
-    has_queued_charges: boolean;
-    locked_pending_charge_id: number | null;
-    max_retries_reached: boolean;
-    order_interval_frequency: number;
-    price: string;
-    status: SubscriptionStatus;
 }
-interface CustomerSubscriptionResponse {
+interface SubscriptionsResponse {
     next_cursor: null | string;
     previous_cursor: null | string;
-    subscriptions: CustomerSubscription[];
+    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> {
@@ -487,8 +988,54 @@ interface SubscriptionListParams extends ListParams<SubscriptionSortBy> {
     created_at_max?: IsoDateString;
     customer_id?: string;
 }
+declare type RequiredCreateProps = 'address_id' | 'charge_interval_frequency' | 'external_variant_id' | 'next_charge_scheduled_at' | 'order_interval_frequency' | 'order_interval_unit' | 'quantity';
+declare type OptionalCreateProps = '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, RequiredCreateProps, OptionalCreateProps>;
+declare type OptionalUpdateProps = '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, OptionalUpdateProps>>;
+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 const listSubscriptions: (query?: SubscriptionListParams) => Promise<CustomerSubscriptionResponse>;
+declare const getSubscription: (id: string | number) => Promise<Subscription>;
+declare const listSubscriptions: (query?: SubscriptionListParams) => Promise<SubscriptionsResponse>;
+/**
+ * When creating a subscription via API, order_interval_frequency and charge_interval_frequency values do not necessarily
+ * need to match the values set in the respective Plans. The product, however, does need to have at least one Plan in order
+ * to be added to a subscription.
+ */
+declare const createSubscription: (data: CreateSubscriptionRequest) => Promise<Subscription>;
+/**
+ * Updating parameters like frequency, charge_interval_frequency, order_interval_frequency, order_interval_unit will cause our algorithm to automatically recalculate the next charge date (next_charge_scheduled_at).
+ * WARNING: This update will remove skipped and manually changed charges.
+ * If you want to change the next charge date (next_charge_scheduled_at) we recommend you to update these parameters first.
+ * When updating order_interval_unit OR order_interval_frequency OR charge_interval_frequency all three parameters are required.
+ */
+declare const updateSubscription: (id: string | number, data: UpdateSubscriptionRequest, query?: UpdateSubscriptionParams) => Promise<Subscription>;
+/**
+ * If there are two active subscriptions with the same address_id, and you update their
+ * next_charge_date parameters to match, their charges will get merged into a new charge
+ * with a new id
+ */
+declare const updateSubscriptionChargeDate: (id: string | number, date: IsoDateString) => Promise<Subscription>;
+declare const updateSubscriptionAddress: (id: string | number, address_id: string | number) => Promise<Subscription>;
+/**
+ * An involuntary subscription cancelled due to max retries reached will trigger the
+ * charge/max_retries_reached webhook. If this leads to the subscription being cancelled,
+ * the subscription/cancelled webhook will trigger.
+ */
+declare const cancelSubscription: (id: string | number, data: CancelSubscriptionRequest) => Promise<Subscription>;
+/**
+ * When activating subscription, following attributes will be set to null: cancelled_at, cancellation_reason
+ * and cancellation_reason_comments.
+ */
+declare const activateSubscription: (id: string | number) => Promise<Subscription>;
 
 declare type InitOptions = Omit<Partial<StorefrontOptions>, 'environment' | 'apiKey'>;
 declare const api: {
@@ -499,4 +1046,4 @@ declare const api: {
 };
 declare function initRecharge(opt?: InitOptions): void;
 
-export { Bundle, 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, FirstOption, GetRequestOptions, InitOptions, IntervalUnit, Method, PriceAdjustmentsType, Request, RequestHeaders, RequestOptions, RequestOptionsHeaders, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, Translations, WidgetIconColor, WidgetTemplateType, api, getBundleId, getBundleSettings, getProduct, getProductAndSettings, getProducts, getProductsAndSettings, getStoreSettings, getWidgetSettings, initRecharge, listSubscriptions, login, logout, resetCache, validateBundle };
+export { Bundle, 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, FirstOption, GetRequestOptions, InitOptions, IntervalUnit, Method, PriceAdjustmentsType, Request, RequestHeaders, RequestOptions, RequestOptionsHeaders, StorefrontEnvironment, StorefrontOptions, StorefrontPurchaseOption, Translations, WidgetIconColor, WidgetTemplateType, activateSubscription, api, applyDiscount, cancelSubscription, captureCharge, createOnetime, createSubscription, deleteOnetime, getBundleId, getBundleSettings, getCharge, getOnetime, getOrder, getProduct, getProductAndSettings, getProducts, getProductsAndSettings, getStoreSettings, getSubscription, getWidgetSettings, initRecharge, listCharges, listOnetimes, listOrders, listSubscriptions, login, logout, processCharge, refundCharge, removeDiscount, resetCache, skipCharge, unskipCharge, updateOnetime, updateSubscription, updateSubscriptionAddress, updateSubscriptionChargeDate, validateBundle };