Sign in
Subscriptions

Update a subscription

Updates an active subscription's properties including billing period, add-ons, unit quantities, and discounts.

patch/api/v1/subscriptions/{id}

Path parameters

idstring required

The unique identifier of the entity

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

metadataobject

Additional metadata for the subscription

trialEndDatestring date-time

Subscription trial end date

promotionCodestring

Promotion code

billingPeriod'MONTHLY' | 'ANNUALLY'
awaitPaymentConfirmationboolean

Await payment confirmation

scheduleStrategy'END_OF_BILLING_PERIOD' | 'END_OF_BILLING_MONTH' | 'IMMEDIATE'
billingCycleAnchor'UNCHANGED' | 'NOW'
cancellationDatestring date-time nullable

Subscription cancellation date

salesforceIdstring nullable

Salesforce ID

Response

The updated subscription object.

Changes

Changed in 9 of the 115 revisions of this API.105

  • 913f273cc2f711See the full diff
    • ●

      added the new ContractNotFound enum value to the code response property for the response status 404

      response-property-enum-value-added

    • ○

      added the optional property data/contractId to the response with the 200 status

      response-optional-property-added

  • b876edd1a4fc5See the full diff
    • ●

      added the new CreditOveragePriceCurrencyNotFound enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new InvalidCreditOverageBillingModel enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new OveragePriceNotSupportedOnAddon enum value to the code response property for the response status 400

      response-property-enum-value-added

    • ●

      added the new OveragePriceRequiresUsageLimit enum value to the code response property for the response status 400

      response-property-enum-value-added

  • 58bb216ff8ce1See the full diff
    • ●

      added the new GovernanceNotEnabled enum value to the code response property for the response status 403

      response-property-enum-value-added

  • 18f71194cc721See the full diff
    • ○

      added the new optional request property salesforceId

      new-optional-request-property

  • 3acd63d6c8612See the full diff
    • ○

      added the new optional header request parameter X-ACCOUNT-ID

      new-optional-request-parameter

    • ○

      added the new optional header request parameter X-ENVIRONMENT-ID

      new-optional-request-parameter

  • 3680d2ae80071See the full diff
    • ○

      added the new optional request property cancellationDate

      new-optional-request-property

  • 4fa87d66426d1See the full diff
    • ●

      added the new PricingModelNotSupportedByBillingIntegration enum value to the code response property for the response status 400

      response-property-enum-value-added

  • 0dece860f6781See the full diff
    • ●

      added the new DataExportIntegrationError enum value to the code response property for the response status 400

      response-property-enum-value-added

  • b181b166a2a51See the full diff
    • ●

      added the new InvalidReceivedSignatureError enum value to the code response property for the response status 400

      response-property-enum-value-added