CreateSubscriptionRequest
Extends
Properties
address_id
address_id:
number
Unique numeric identifier for the address the subscription is associated with.
Inherited from
SubType.address_id
charge_interval_frequency
charge_interval_frequency:
number
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
Inherited from
SubType.charge_interval_frequency
expire_after_specific_number_of_charges?
expire_after_specific_number_of_charges?:
number
Set the number of charges until subscription expires.
Inherited from
SubType.expire_after_specific_number_of_charges
external_product_id?
external_product_id?:
ExternalId
An object containing the product id as it appears in external platforms.
Inherited from
SubType.external_product_id
external_variant_id
external_variant_id:
ExternalId
An object containing the variant id as it appears in external platforms.
Inherited from
SubType.external_variant_id
gift_id?
gift_id?:
number
When creating a subscription using a gift, pass the credit_account_id that is associated with that gift.
This will create the subscription using the credit account associated with the gift.
next_charge_scheduled_at
next_charge_scheduled_at:
string
Date of the next charge for the subscription.
Inherited from
SubType.next_charge_scheduled_at
order_day_of_month?
order_day_of_month?:
number
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”.
Inherited from
SubType.order_day_of_month
order_day_of_week?
order_day_of_week?:
number
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.
Inherited from
SubType.order_day_of_week
order_interval_frequency
order_interval_frequency:
number
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
Inherited from
SubType.order_interval_frequency
order_interval_unit
order_interval_unit:
IntervalUnit
The frequency unit used to determine when a subscription’s order is created.
Inherited from
SubType.order_interval_unit
properties?
properties?:
Property[]
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.
Inherited from
SubType.properties
quantity
quantity:
number
The number of items in the subscription.
Inherited from
SubType.quantity
status?
status?:
SubscriptionStatus
The status of the subscription. expired - This status occurs when the maximum number of charges for a product has been reached.
Inherited from
SubType.status
Generated using typedoc-plugin-markdown and TypeDoc