Interface: SubscriptionUpdateProps
react-autonomyreact-autonomy.SubscriptionUpdateProps
Properties
actionableDate
• Optional actionableDate: string
A date string representing when the subscription should resume. The minimum date is the next day. If actionableDate is omitted, the subscription will be resumed the next day.
Defined in
bill_address_attributes
• Optional bill_address_attributes: SubscriptionAddressSubscriptionAddress
An object representing the billing address. All fields need to be sent even if only a single field is updated.
Defined in
endDate
• Optional endDate: string
A string representing the end date of the subscription. If null, the subscription will renew indefinitely.
Defined in
intervalLength
• Optional intervalLength: number
The number of units. Example: if the subscription should be delivered every three months, this would be 3.
Defined in
intervalUnits
• Optional intervalUnits: IntervalUnitIntervalUnit
The interval unit. Example: if the subscription should be delivered every three months, this would be month.
Defined in
lineItemsAttributes
• Optional lineItemsAttributes: SubscriptionUpdateLineItemAttributes[]
An object representing the line item attributes to be updated. To change the variant in the subscription, pass two lineItemsAttributes objects in the array, one representing the variant to be removed with _destroy: true, and one respresenting the variant to be added.
Defined in
payment_source_attributes
• Optional payment_source_attributes: SubscriptionPaymentSourceSubscriptionPaymentSource
An object representing the payment source. All fields need to be sent even if only a single field is updated.
Defined in
ship_address_attributes
• Optional ship_address_attributes: SubscriptionAddressSubscriptionAddress
An object representing the shipping address. All fields need to be sent even if only a single field is updated.