Update Subscription
Update metadata about the subscription
Updates the metadata about the subscription. This endpoint allows you to update the name, status, and other metadata about the subscription.
To update pricing information, use the Update Subscription Version endpoint.
Params
The unique identifier of the subscription to update
Request
The name of the subscription, e.g., “Waystar Royco - 2024”
The initial status of the subscription. Possible values: draft, sent,
accepted, active, canceled
A brief description of the subscription, such as “Initial contract for Waystar Royco”
The period type for the contract. Possible values: monthly_rolling, fixed
The start date and time of the contract in ISO 8601 format. This is when the subscription becomes effective
The end date and time of the contract in ISO 8601 format.
The duration of the contract in the units specified by contractPeriodType. if contractPeriodType is fixed
The initial date when billing should commence for this subscription
The date when invoice generation should begin. This can differ from the contract start date
Number of trial days before billing begins, if applicable
Any additional contract terms specific to this subscription
Links to terms of service documents that apply to this subscription
Files containing terms of service that apply to this subscription
Minimum spending threshold for the subscription
Maximum spending threshold for the subscription
Discount applied to the subscription
Whether to automatically issue invoices for this subscription. If not provided, defaults to the organization’s setting or plan’s setting if creating from a plan
Whether to automatically pay invoices for this subscription. If not provided, defaults to the customer’s setting or plan’s setting if creating from a plan
Whether to send invoices to the customer. If not provided, defaults to the organization’s setting or plan’s setting if creating from a plan
Whether to send receipts to the customer. If not provided, defaults to the organization’s setting or plan’s setting if creating from a plan
Whether the subscription should automatically renew. If not provided, defaults to the plan’s setting if creating from a plan
The period type for renewals. Required if autoRenew is true. Possible values:
monthly_rolling, fixed
The duration for renewals. Required if renewalPeriodType is fixed
The reason for cancelation if the subscription is being canceled. Possible values depend on your organization’s configured cancelation reasons.
Additional description or notes regarding the cancelation reason.
Payment terms for invoices. Possible values: on_issue, net_7, net_15,
net_30, net_60, net_90, indefinite
Template for invoice memos
Text to display in the footer of invoices
Whether to send an activation email when the subscription is activated
Response
Unique identifier for the subscription
When the subscription was created in ISO 8601 format
When the subscription was last updated in ISO 8601 format
The organization ID that owns this subscription
The name of the subscription, e.g., "Enterprise Plan - 2024"
The customer account ID associated with this subscription. This is typically an Alguna customer ID
The purchase order number provided by the customer for this subscription
A brief description of the subscription, such as "Annual enterprise subscription"
Number of trial days before billing begins
Any additional contract terms specific to this subscription
Links to terms of service documents that apply to this subscription
Files containing terms of service that apply to this subscription
Minimum spending threshold for the subscription
Maximum spending threshold for the subscription
When the contract begins in ISO 8601 format
When the contract ends in ISO 8601 format. Only set if contractPeriodType is fixed
The duration of the contract in the units specified by contractPeriodType
The period type for the contract. Possible values: monthly_rolling, fixed
Discount applied to the subscription
The currency for the subscription (e.g., "USD")
The original currency if the subscription was converted from another currency
The rate used for currency conversion, if applicable
When the conversion rate was determined
Current status of the subscription. Possible values: draft, sent,
accepted, active, canceled
ID of the quote template used, if applicable
Name of the person who signed the subscription
Email of the person who signed the subscription
Job title of the person who signed the subscription
Reason for cancellation if the subscription was canceled. Possible values:
no_longer_required, moving_provider, pricing, support, features,
other
Additional details about the cancellation reason
When the subscription was activated
When the subscription ended
Whether invoices are automatically issued for this subscription
Whether invoices are automatically paid for this subscription
Whether invoices are sent to the customer
Whether receipts are sent to the customer
When invoice generation begins in ISO 8601 format. This can differ from the contract start date
Whether the subscription automatically renews
The period type for renewals. Possible values: monthly_rolling, fixed
The duration for renewals if renewalPeriodType is fixed
History of subscription renewals, with details about each renewal event
The initial billing date in ISO 8601 format
The most recent billing date in ISO 8601 format
Whether one-off prices are charged at contract start rather than on the first billing date
Whether the subscription has a generated PDF document
Payment terms for invoices. Possible values: on_issue, net_7, net_15,
net_30, net_60, net_90, indefinite
Template for invoice memos
Text displayed in the footer of invoices for this subscription
Whether an activation email is sent when the subscription is activated