Updates a subscription.
Open in API Reference
The ID of the subscription to update.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
The subscription object containing the current version, and fields to update. Unset fields will be left at their current server values, and JSON null values will be treated as a request to clear the relevant data.
null
The list of scheduled actions on this subscription. It is set only in the response from RetrieveSubscription with the query parameter of include=actions or from SearchSubscriptions with the input parameter of include:["actions"].
include=actions
include:["actions"]
A nonexistent value. In an API request this value will appear as null. Can be used to clear a field entirely.
The YYYY-MM-DD-formatted date (for example, 2013-01-15) to cancel the subscription, when the subscription status changes to CANCELED and the subscription billing stops.
YYYY-MM-DD
CANCELED
If this field is not set, the subscription ends according its subscription plan.
This field cannot be updated, other than being cleared.
The ID of the subscriber's card used to charge for the subscription.
A custom price to apply for the subscription. If specified, it overrides the price configured by the subscription plan.
The origination details of the subscription.
The tax amount applied when billing the subscription. The percentage is expressed in decimal form, using a '.' as the decimal separator and without a '%' sign. For example, a value of 7.5 corresponds to 7.5%.
'.'
'%'
7.5
The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.
// No response received yet.