Subscriptions

#The subscription object

Attributes

• idinteger
  Unique numeric identifier for the subscription.
• additional_variant_dataobjectNew
  An object containing variant values stored on the Subscription. Each key holds an object with the stored value and an override boolean that is true when the value was set explicitly on the Subscription. The object is empty when no values are stored.
  Only returned by the retrieve and list endpoints for stores that have enhanced subscription responses enabled.
  Show child attributesHide child attributes55 new

  • fulfillment_serviceobjectNew
    The fulfillment service of the variant, as value and override.
  • gramsobjectNew
    The weight of the variant in grams, as value and override.
  • tax_codeobjectNew
    The tax code of the variant, as value and override.
  • taxableobjectNew
    Whether the variant is taxable, as value and override.
  • vendorobjectNew
    The vendor of the variant, as value and override.
• address_idinteger
  Unique numeric identifier for the address the subscription is associated with.
• customer_idinteger
  Unique numeric identifier for the customer the subscription is tied to.
• analytics_dataobject
  An object used to contain analytics data such as utm parameters.
  Show child attributesHide child attributes1

  • utm_paramsarray of objects
    An array containing utm_param objects.
    Show child attributesHide child attributes7

    • utm_campaignstring
      The UTM campaign.
    • utm_contentstring
      The UTM content.
    • utm_data_sourcestring
      The source of the campaign parameter.
    • utm_sourcestring
      The UTM source.
    • utm_mediumstring
      The UTM medium.
    • utm_termstring
      The UTM term.
    • utm_timestampstring
      The UTM timestamp.
• cancellation_reasonstring
  Reason provided for cancellation.
• cancellation_reason_commentsstring
  Additional comment for cancellation. Maximum length is 1024 characters.
• cancelled_atdatetime
  The time the subscription was cancelled.
• charge_interval_frequencyinteger
  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.
  Maximum 1000
  Charges must use the same unit types as orders.
• includeobjectNew
  An object containing the related objects requested with the include query parameter.
  Only returned when the include query parameter is passed on the retrieve or list endpoints.
  Show child attributesHide child attributes917 new

  • addonsarray of objectsNew
    The add-on relationships of the Subscription with other subscriptions.
    Returned when include contains addons. Only populated for stores with add-on subscriptions enabled.
    Show child attributesHide child attributes33 new

    • typestringNew
      The role of the related subscription: child when the related subscription is an add-on of this Subscription, parent when this Subscription is an add-on of the related subscription.
      Possible values

      childparent
    • parent_subscription_idintegerNew
      Unique numeric identifier of the parent Subscription in the relationship.
    • child_subscription_idintegerNew
      Unique numeric identifier of the add-on Subscription in the relationship.
  • addressobjectNew
    The Address the Subscription is associated with.
    Returned when include contains address.
  • bundle_productobject · nullableNew
    The bundle product that matches the product of the Subscription. null if the product is not a bundle.
    Returned when include contains bundle_product.
  • bundle_selectionsobject · nullableNew
    The BundleSelection linked to the Subscription. null if there is none.
    Returned when include contains bundle_selections.
  • charge_activitiesarrayNew
    The charge activity records created in the last 90 days for the Charges that contain the Subscription.
    Returned when include contains charge_activities.
  • customerobjectNew
    The Customer the Subscription is tied to.
    Returned when include contains customer.
  • customer_entitlementsarray of objectsNew
    The entitlements granted to the Customer by the Subscription.
    Returned when include contains customer_entitlements.
    Show child attributesHide child attributes55 new

    • idintegerNew
      Unique numeric identifier for the customer entitlement.
    • descriptionstring · nullableNew
      The description of the entitlement feature.
    • expires_atdatetime · nullableNew
      The time the entitlement expires. null if it does not expire.
    • lookup_keystringNew
      The lookup key of the entitlement feature.
    • namestringNew
      The name of the entitlement feature.
  • expires_atarrayNew
    A list containing the date on which the Subscription expires as an add-on, or null if it has no expiration.
    Returned when include contains expires_at. Only populated for stores with add-on subscriptions enabled.
  • metafieldsarrayNew
    The Metafields attached to the Subscription.
    Returned when include contains metafields.
• is_digitalbooleanNew
  Value is true if the Subscription is for a digital item, meaning the item does not require shipping and its Plan grants at least one entitlement. Always false for stores that do not have digital subscriptions enabled.
• locked_pending_charge_idinteger · nullableNew
  Unique numeric identifier of the Charge that is waiting for a payment confirmation for this Subscription. The Subscription cannot be modified while this value is set.
  Only returned for stores that have SEPA Direct Debit or iDEAL payments enabled.
• plan_idinteger · nullableNew
  Unique numeric identifier of the Plan the Subscription is linked to.
  Only returned for stores that have plan IDs in subscription responses enabled.
• created_atdatetime
  The time the subscription was created.
• expire_after_specific_number_of_chargesinteger
  Set the number of charges until subscription expires.
• external_product_idobject
  An object containing the product id as it appears in external platforms.
  Show child attributesHide child attributes1

  • ecommercestring
    The product id as it appears in the external e-commerce platform. The external_product_id of the Product record in Recharge, linking a Plan to a Product.
• external_variant_idobject
  An object containing the variant id as it appears in external platforms.
  Show child attributesHide child attributes1

  • ecommercestring
    The variant id as it appears in the external e-commerce platform. The external_variant_id of the Product record in Recharge, linking a Plan to a Product.
• has_queued_chargesboolean
  Retrieves true if there is queued charge. Otherwise, retrieves false.
• is_prepaidboolean
  Value is set to true if it is a prepaid item.
• is_skippableboolean
  Value is set to true if it is not a prepaid item
• is_swappableboolean
  Value is set to true if it is not a prepaid item and if in Customer portal settings swap is allowed for customers.
• max_retries_reachedboolean
  Retrieves true if charge has an error max retries reached. Otherwise, retrieves false.
• next_charge_scheduled_atdate
  Date of the next charge for the subscription.
• order_day_of_monthinteger
  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_weekinteger
  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_interval_frequencyinteger
  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
  Maximum 1000
• order_interval_unitstring
  The frequency unit used to determine when a subscription's order is created.
  Possible values

  dayweekmonth
• presentment_currencystring
  The presentment currency of the subscription.
• pricestring
  The price of the item before discounts, taxes, or shipping have been applied.
• product_titlestring
  The name of the product in a store's catalog.
• propertiesarray of objects
  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.
  Show child attributesHide child attributes2

  • namestring
    The name of the property.
  • valuestring
    The value of the property.
• quantityinteger
  The number of items in the subscription.
• skustring
  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_overrideboolean
  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.
• statusstring
  The status of the subscription.
  Possible values

  activecancelledexpired
  EXPIRED - This status occurs when the maximum number of charges for a product has been reached.
• updated_atdatetime
  The date time at which the purchase_item record was last updated.
• variant_titlestring
  The name of the variant in a shop’s catalog.

#Create a subscription

Query parameters

• commitbooleanNew
  If set to true, the QUEUED charges linked to the Subscription are regenerated before the response is returned. If omitted or false, the charges are regenerated asynchronously.

Body parameters

• address_idintegerRequired
  Unique numeric identifier of the customer’s address.
• analytics_dataobjectNew
  An object used to contain analytics data such as utm parameters.
  Show child attributesHide child attributes18 new

  • utm_paramsarray of objectsNew
    An array containing utm_param objects.
    Show child attributesHide child attributes77 new

    • utm_campaignstringNew
      The UTM campaign.
    • utm_contentstringNew
      The UTM content.
    • utm_data_sourcestringNew
      The source of the campaign parameter. Required for each utm_param object.
    • utm_mediumstringNew
      The UTM medium.
    • utm_sourcestringNew
      The UTM source.
    • utm_termstringNew
      The UTM term.
    • utm_timestampdatetimeNew
      The UTM timestamp. Required for each utm_param object.
• cancellation_reasonstringNew
  Reason for cancellation. Can only be set when status is cancelled or expired.
• cancelled_atdatetimeNew
  The time the subscription was cancelled. Can only be set when status is cancelled or expired. Defaults to the current time when status is cancelled.
• charge_interval_frequencyintegerRequired
  The number of units, specified in order_interval_unit, between each charge.
• custom_event_attributesarray of objectsNew
  A list of up to 10 custom key-value pairs to attach to the Events generated by this request. They are returned in the custom_attributes of those Events.
  Show child attributesHide child attributes22 new

  • keystringNew
    The name of the custom attribute.
  • valuestring · nullableNew
    The value of the custom attribute. Maximum length is 255 characters.
• expire_after_specific_number_of_chargesinteger
  The number of charges until the subscription expires.
• next_charge_scheduled_atdateRequired
  This will set the first charge date of a new subscription.
• order_day_of_monthinteger
  This is populated when order_interval_unit has value “month”. Default value is 0.
• order_day_of_weekinteger
  This is populated when order_interval_unit has value “week”.
• order_interval_frequencyintegerRequired
  The number of units, specified in order_interval_unit, between each order.
• order_interval_unitstringRequired
  The frequency unit used to determine when a subscription order is created.
  Possible values

  dayweekmonth
• plan_idinteger
  A Recharge Plan id that provides interval information. Automatically fills the following properties from the plan if they were not provided directly: charge_interval_frequency, expire_after_specific_number_of_charges, order_day_of_month, order_day_of_week, order_interval_frequency, order_interval_unit.
• presentment_currencystringNew
  The presentment currency of the price. It must match the currency of the Address. Required when price is provided and the currency of the Address is not the store's default currency.
• pricestring
  The price of the product.
• price_manually_setbooleanNew
  Set to true to indicate that the price in the request was explicitly chosen by the caller instead of being calculated by Recharge.
• product_titlestring
  The name of the product.
• propertiesarray of objects
  A list of key/value pairs representing properties of the subscription.
  Show child attributesHide child attributes2

  • namestring
    The name of the property.
  • valuestring
    The value of the property.
• quantityintegerRequired
  The quantity of the product.
• external_product_idobject
  Unique numeric identifier of the product id.
  Show child attributesHide child attributes1

  • ecommercestring
    The product id as it appears in the external e-commerce platform. The external_product_id of the Product record in Recharge, linking a Plan to a Product.
• external_variant_idobjectRequired
  Unique numeric identifier of the product variant id.
  Show child attributesHide child attributes1

  • ecommercestring
    The variant id as it appears in the external e-commerce platform. The external_variant_id of the Product record in Recharge, linking a Plan to a Product.
• skustringNew
  A unique identifier of the item in the fulfillment.
• sku_overridebooleanNew
  When true, the sku stored on the Subscription is used instead of the SKU of the product variant.
• statusstring
  Default is set to active.
  Possible values

  activecancelledexpired
• variant_titlestringNew
  The name of the product variant.

#Retrieve a subscription

Query parameters

• includestringNew
  A comma-separated list of related objects to return in the include attribute of the Subscription. address, customer and customer_entitlements also require the read_customers scope, and charge_activities also requires the read_orders scope. addons and expires_at only return data for stores with add-on subscriptions enabled.
  Possible values

  addressaddonsbundle_productbundle_selectionscharge_activitiescustomercustomer_entitlementsexpires_atmetafields

#Update a subscription

Query parameters

• commitboolean
  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.
• force_updateboolean
  If set to True, updates will also be applied to CANCELLED subscriptions. If null or False, only ACTIVE subscriptions will be updated.

Body parameters

• address_idintegerNew
  Unique numeric identifier of the Address to move the Subscription to. The Address must belong to the same Customer and use the same currency as the Subscription.
• analytics_dataobjectNew
  An object used to contain analytics data such as utm parameters. The UTM parameters passed are added to the ones already stored on the Subscription.
  Show child attributesHide child attributes18 new

  • utm_paramsarray of objectsNew
    An array containing utm_param objects.
    Show child attributesHide child attributes77 new

    • utm_campaignstringNew
      The UTM campaign.
    • utm_contentstringNew
      The UTM content.
    • utm_data_sourcestringNew
      The source of the campaign parameter. Required for each utm_param object.
    • utm_mediumstringNew
      The UTM medium.
    • utm_sourcestringNew
      The UTM source.
    • utm_termstringNew
      The UTM term.
    • utm_timestampdatetimeNew
      The UTM timestamp. Required for each utm_param object.
• cancellation_reasonstringNew
  Reason for cancellation. Can only be set when status is passed as cancelled or expired in the same request.
• cancellation_reason_commentsstringNew
  Additional comment for cancellation. Maximum length is 1024 characters. Can only be set when status is passed as cancelled or expired in the same request.
• cancelled_atdatetimeNew
  The time the subscription was cancelled. Can only be set when status is passed as cancelled or expired in the same request.
• charge_interval_frequencyinteger
  The number of units (specified in order_interval_unit) between each charge. Required when updating order_interval_unit.
  
  WARNING: This update will remove skipped and manually changed charges.
  Maximum 1000
• custom_event_attributesarray of objectsNew
  A list of up to 10 custom key-value pairs to attach to the Events generated by this request. They are returned in the custom_attributes of those Events.
  Show child attributesHide child attributes22 new

  • keystringNew
    The name of the custom attribute.
  • valuestring · nullableNew
    The value of the custom attribute. Maximum length is 255 characters.
• expire_after_specific_number_of_chargesinteger
  The number of charges until subscription expires.
• external_product_idobjectNew
  An object containing the product id as it appears in external platforms.
  Show child attributesHide child attributes11 new

  • ecommercestringNew
    The product id as it appears in the external e-commerce platform.
• external_variant_idobject
  Unique number identifier of the product variant in your external platform.
  Show child attributesHide child attributes1

  • ecommercestring
    The variant id as it appears in the external e-commerce platform. The external_variant_id of the Product record in Recharge, linking a Plan to a Product.
• next_charge_scheduled_atdateNew
  The date of the next charge for the Subscription. It cannot be in the past.
• order_day_of_monthinteger
  The day of the month the order is created on.
  
  WARNING: this update will remove skips and manually changed charges.
• order_day_of_weekinteger
  The day of the week the order is created on.
  
  WARNING: this update will remove skips and manually changed charges.
• order_interval_frequencyinteger
  The number of units (specified in order_interval_unit) between each order. Required when updating order_interval_unit.
  
  WARNING: This update will remove skipped and manually changed charges.
• order_interval_unitstring
  The frequency unit used to determine when a subscription order is created.
  
  WARNING: This update will remove skipped and manually changed charges.
  Possible values

  dayweekmonth
• overridebooleanNew
  If set to true, allows interval changes that are otherwise rejected, such as changing the charge or order frequency of a prepaid Subscription, or changing a Subscription to a prepaid frequency.
• plan_idinteger
  A Recharge Plan id that provides interval information. Automatically fills the following properties from the plan if they were not provided directly: charge_interval_frequency, expire_after_specific_number_of_charges, order_day_of_month, order_day_of_week, order_interval_frequency, order_interval_unit.
• presentment_currencystringNew
  The presentment currency of the price. It must match the currency of the Subscription. Required when price is provided and the currency of the Subscription is not the store's default currency.
• pricestring
  The price of the item before discounts, taxes, or shipping has been applied.
• price_manually_setbooleanNew
  Set to true to indicate that the price in the request was explicitly chosen by the caller instead of being calculated by Recharge.
• product_titlestring
  The name of the product.
• propertiesarray of objects
  A list of key/value pairs representing properties of the subscription.
  Show child attributesHide child attributes2

  • namestring
    The name of the property.
  • valuestring
    The value of the property.
• quantityinteger
  The number of items in the subscription.
• skustring
  A unique identifier of the item in the fulfillment.
• sku_overrideboolean
  Flag 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.
• statusstringNew
  The status of the Subscription. When set to cancelled without cancelled_at, the cancellation time is set to the current time.
  Possible values

  activecancelledexpired
• use_external_variant_defaultsboolean
  Flag instructing to pull the price from the product variant passed.
  You need to pass the variant_id under external_variant_id.ecommerce and set this attribute to true in the request for the flag to work.
• variant_titlestring
  The name of the product variant.

#Delete a subscription

Query parameters

• commitbooleanNew
  If set to true, the QUEUED charges linked to the Subscription are regenerated before the response is returned. If omitted or false, the charges are regenerated asynchronously.

Body parameters

• send_emailboolean
  When your store setting indicates that cancellation emails should be sent, this value determines if the email should be sent for the specified subscription cancellation.
  If set to true, cancellation emails will be sent for the specified subscription cancellations. If set to false, cancellation emails will not be sent.

#List subscriptions

Query parameters

• address_idstring
  Return the subscriptions linked to the given address_id.
  Not compatible with address_ids.
• address_idsstring
  Return the subscriptions linked to the given address_ids.
  Accepts a comma separated list of address_ids as value.
  Not compatible with address_id
• bundles_onlybooleanNew
  If true, only return the subscriptions whose product variant belongs to an active, published bundle product. Only true is accepted; omit the parameter to list all subscriptions.
• created_at_maxstring
  Return the subscriptions created before the given date.
• created_at_minstring
  Return the subscriptions created after the given date.
• cursorstring
  Return either the next or previous page of subscriptions using next_cursor or previous_cursor attributes in the response.
• customer_idstring
  Return the subscriptions linked to the given Recharge customer id.
• external_customer_idstringNew
  Return the subscriptions linked to the customer with the given id in the external e-commerce platform.
• external_variant_idstring
  Return the subscriptions linked to the given external_variant_id
• idsstring
  Comma-separated list of subscription_ids to filter
• includestringNew
  A comma-separated list of related objects to return in the include attribute of the Subscriptions. address, customer and customer_entitlements also require the read_customers scope, and charge_activities also requires the read_orders scope. addons and expires_at only return data for stores with add-on subscriptions enabled.
  Possible values

  addressaddonsbundle_productbundle_selectionscharge_activitiescustomercustomer_entitlementsexpires_atmetafields
• include_onetimesbooleanNew
  If true, the response also contains an onetimes array with the Onetimes matching the same filters. Only applied when address_id, customer_id or external_customer_id is also passed.
  Only available for stores that have the option to include onetimes in the subscriptions list enabled.
• limitstring
  The number of results.
  Default 50Maximum 250
• pagestringDeprecated
  The page to show.
  Default 1
  Page-based pagination has been deprecated but still available to use for pages up to a 100. If you need data past this point, use cursor pagination.
• sort_bystringNew
  Sort the results by the given attribute and direction. Defaults to id-desc.
  Possible values

  id-ascid-desccreated_at-asccreated_at-descupdated_at-ascupdated_at-desc
• statusstring
  Return the subscriptions with specified status.
  Possible values

  activecancelledexpired
• updated_at_maxstring
  Return the subscriptions updated before the given date.
• updated_at_minstring
  Return the subscriptions updated after the given date.

#Change a subscription next charge date

Query parameters

• commitbooleanNew
  If set to true, the QUEUED charges linked to the Subscription are regenerated before the response is returned. If omitted or false, the charges are regenerated asynchronously.
• pausebooleanNew
  If true, the date change is also recorded as a pause of the Subscription and the subscription/paused webhook is sent.

Body parameters

• datedateRequired
  The next charge date desired.
• custom_event_attributesarray of objectsNew
  A list of up to 10 custom key-value pairs to attach to the Events generated by this request. They are returned in the custom_attributes of those Events.
  Show child attributesHide child attributes22 new

  • keystringNew
    The name of the custom attribute.
  • valuestring · nullableNew
    The value of the custom attribute. Maximum length is 255 characters.

#Change a subscription address

Body parameters

• address_idintegerRequired
  Unique id of the address that need to be associated with subscription.
• next_charge_scheduled_atstring
  The next charge date desired.

#Cancel a subscription

Query parameters

• commitbooleanNew
  If set to true, the QUEUED charges linked to the Subscription are regenerated before the response is returned. If omitted or false, the charges are regenerated asynchronously.

Body parameters

• cancellation_reasonstring
  Reason for subscription cancellation.
• cancellation_reason_commentsstring
  Cancellation reason comment. Maximum length is 1024 characters.
• send_emailboolean
  If set to false, subscription cancelled email will not be sent to customer and store owner. Note: even if set to True, there are some conditions where an email will not be sent. They are: inactive subscription_cancellation email template, customer or subscription was created on the same day, subscription is for a membership, email already sent for this subscription in the last 24 hours, customer has other active subscriptions or onetimes
• overridebooleanNew
  If set to true, the cancellation reason and comments can be replaced on a Subscription that was already cancelled after reaching the maximum number of charge attempts.

#Activate a subscription

Query parameters

• commitbooleanNew
  If set to true, the QUEUED charges linked to the Subscription are regenerated before the response is returned. If omitted or false, the charges are regenerated asynchronously.

Body parameters

• custom_event_attributesarray of objectsNew
  A list of up to 10 custom key-value pairs to attach to the Events generated by this request. They are returned in the custom_attributes of those Events.
  Show child attributesHide child attributes22 new

  • keystringNew
    The name of the custom attribute.
  • valuestring · nullableNew
    The value of the custom attribute. Maximum length is 255 characters.

#Gift a skipped subscription

Body parameters

• purchase_item_idsarrayRequired
  A list containing the Subscription IDs to be skipped.
• recipient_addressobjectRequired
  An object that contains information associated with the giftee's Address
  Show child attributesHide child attributes11

  • address1stringRequired
    The street associated with the giftee Address.
  • address2string
    Any additional information associated with the giftee Address.
  • citystringRequired
    The city associated with the giftee address.
  • companystring
    The company associated with the giftee address.
  • country_codestringRequired
    2-letter country code.
  • first_namestringRequired
    The giftee's first name associated with the address.
  • last_namestringRequired
    The giftee's last name associated with the address.
  • phonestring
    The giftee's phone number associated with the address.
  • provincestringRequired
    The state or province associated with the giftee address.
  • zipstringRequired
    The zip or postal code associated with the giftee address.
  • emailstringRequired
    Email address for the giftee.
    will be required for sending the notification to the giftee.

Response attributes

• idinteger
  Unique numeric identifier for the Onetime purchase.
• address_idinteger
  Unique numeric identifier for the address the Onetime Purchase is associated with (cannot be used with next_charge_scheduled_at)
• created_atdatetime
  The time the Onetime item was first created.
• customer_idinteger
  Unique numeric identifier for the customer the Onetime purchase is tied to.
• external_product_idstring
  An object containing the product id as it appears in external platforms.
  Show child attributesHide child attributes1

  • ecommercestring
    The product id as it appears in the external e-commerce platform. The external_product_id of the Product record in Recharge, linking a Plan to a Product.
• external_variant_idstring
  An object containing the variant id as it appears in external platforms.
  Show child attributesHide child attributes1

  • ecommercestring
    The variant id as it appears in the external e-commerce platform. The external_variant_id of the Product record in Recharge, linking a Plan to a Product.
• is_cancelledboolean
  Flag indicating if the the onetime is cancelled.
• next_charge_scheduled_atdatetime
  Date of the Onetime purchase execution.
  Cannot be used with add_to_next_charge
• pricestring
  The price of the item before discounts, taxes, or shipping have been applied.
• product_titlestring
  The name of the product in a shop’s catalog.
• propertiesarray of objects
  An array containing key value pairs for any supplementary data.
  Show child attributesHide child attributes2

  • namestring
    The name of the property.
  • valuestring
    The value of the property.
• quantityinteger
  The number of items in the Onetime purchase.
• skustring
  A unique identifier of the item in the fulfillment.
• sku_overrideboolean
  Flag that is automatically updated to true when SKU is passed on POST or PUT.
  When sku_override is true, the sku on the Onetime 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.
• updated_atstring
  The time the Onetime purchase was last updated.
• variant_titlestring
  The name of the variant in a shop’s catalog.

#Skip a future charge for a subscriptionNew

Body parameters

• datedateRequired
  The date of the upcoming charge to skip. It must be at least one day in the future, match a date in the customer's upcoming delivery schedule, and be within the number of days the store allows charges to be skipped in advance (90 by default).

#Preview skipping the next charge of a subscriptionNew

#Bulk change subscription addressesNew

Query parameters

• commitboolean
  If set to true, the QUEUED charges linked to the Subscription are regenerated before the response is returned. If omitted or false, the charges are regenerated asynchronously.

Body parameters

• subscriptionsarray of objectsRequired
  The list of subscriptions to move.
  Show child attributesHide child attributes3

  • idintegerRequired
    Unique numeric identifier of the Subscription to move.
  • address_idintegerRequired
    Unique numeric identifier of the Address the Subscription is moved to.
  • next_charge_scheduled_atdatetime
    The next charge date desired for the Subscription on the new Address. It must be in the future.

#Update a bundle subscription and its contentsNew

Query parameters

• commitboolean
  If set to true, the QUEUED charges linked to the Subscription are regenerated before the response is returned. If omitted or false, the charges are regenerated asynchronously.

Body parameters

• external_product_idobject
  An object containing the product id as it appears in external platforms.
  Show child attributesHide child attributes1

  • ecommercestring
    The product id as it appears in the external e-commerce platform.
• external_variant_idobject
  An object containing the variant id as it appears in external platforms.
  Show child attributesHide child attributes1

  • ecommercestring
    The variant id as it appears in the external e-commerce platform.
• itemsarray of objects
  The list of items that make up the contents of the bundle.
  Show child attributesHide child attributes5

  • collection_idstringRequired
    The id of the collection the item belongs to.
  • external_product_idstringRequired
    The product id of the item as it appears in the external e-commerce platform.
  • external_variant_idstringRequired
    The variant id of the item as it appears in the external e-commerce platform.
  • pricestring
    The price of the item. It cannot be negative.
  • quantityintegerRequired
    The quantity of the item.
• plan_idinteger
  A Recharge Plan id that provides interval information for the Subscription.