Sign in

v1

latestOpenAPI 3.0.32026-07-1336286494.8 KB
api

post/api/subscriptions/update/

Query parameters

customer_idstring nullable required

Filter to a specific customer.

plan_idstring uuid required

Filter to a specific plan.

valuestring required
property_namestring required

The string name of the property to filter on. Example: 'product_id'

Filter to a specific set of subscription filters. If your billing model only allows for one subscription per customer, you very likely do not need this field. Must be formatted as a JSON-encoded + stringified list of dictionaries, where each dictionary has a key of 'property_name' and a key of 'value'.

Request body

replace_plan_idstring uuid

[DEPRECATED] Will currently perform a best-effort attempt to find the correct plan version to replace the current plan with. If more than one plan version matches the criteria, this will return an error. Use the change_plan method of a subscription instance instead.

invoicing_behavior'add_to_next_invoice' | 'invoice_now'

The invoicing behavior to use when replacing the plan. Invoice now will invoice the customer for the prorated difference of the old plan and the new plan, whereas add_to_next_invoice will wait until the end of the subscription to do the calculation.

  • add_to_next_invoice - Add to Next Invoice
  • invoice_now - Invoice Now
usage_behavior'transfer_to_new_subscription' | 'keep_separate'

The usage behavior to use when replacing the plan. Transfer to new subscription will transfer the usage from the old subscription to the new subscription, whereas keep_separate will reset the usage to 0 for the new subscription, while keeping the old usage on the old subscription and charging for that appropriately at the end of the month.

  • transfer_to_new_subscription - Transfer to New Subscription
  • keep_separate - Keep Separate
turn_off_auto_renewboolean

Turn off auto renew for the subscription

end_datestring date-time

Change the end date for the subscription.

Response

subscription_idstring required
start_datestring date-time required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

end_datestring date-time required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

auto_renewboolean required

Whether the subscription automatically renews. Defaults to true.

is_newboolean required

Whether this subscription came from a renewal or from a first-time. Defaults to true on creation.

fully_billedboolean required
metadataobject required