Sign in
Subscriptions

Execute subscription modification

Execute a mid-cycle subscription modification (inheritance, quantity change, grouped invoicing, trial end, coupon, or tax).

post/subscriptions/{id}/modify/execute

Path parameters

idstring required

Subscription ID

Request body

type'inheritance' | 'quantity_change' | 'grouped_invoicing' | 'trial_end' | 'coupon' | 'tax' required

Response

OK

Changes

Changed in 5 of the 12 revisions of this API.16443

  • cef2964c102c334See the full diff
    • ●

      removed the optional property changed_resources/invoices/items/invoice/subscription/customer_timezone from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property subscription/customer_timezone from the response with the 200 status

      response-optional-property-removed

    • ●

      added the new VOIDED enum value to the changed_resources/invoices/items/invoice/payment_status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property coupon_params

      new-optional-request-property

    • ○

      added the new optional request property inheritance_params/action

      new-optional-request-property

    • ○

      added the new optional request property inheritance_params/external_customer_ids_to_remove

      new-optional-request-property

    • ○

      added the new optional request property tax_params

      new-optional-request-property

    • ○

      added the new optional request property trial_end_params

      new-optional-request-property

    • ○

      added the new coupon enum value to the request property type

      request-property-enum-value-added

    • ○

      added the new tax enum value to the request property type

      request-property-enum-value-added

    • ○

      added the new trial_end enum value to the request property type

      request-property-enum-value-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/customer/integrations/items/metadata to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/customer/timezone to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/line_items/items/adjusted_entitlement_quantity to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/line_items/items/subscription_line_item_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/subscription/coupon_associations/items/coupon/coupon_code to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/subscription/coupon_associations/items/subscription_line_item to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/subscription/customer/integrations/items/metadata to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/subscription/customer/timezone to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/subscription/line_items/items/commitment_time_buckets to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/subscription/line_items/items/price/sequence to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/subscription/synced_price_sequence to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/subscription/timezone to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/wallet_transaction/created_by_user/metadata to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/wallet_transaction/created_by_user/name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/wallet_transaction/customer/integrations/items/metadata to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/invoices/items/wallet_transaction/customer/timezone to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/subscriptions/items/current_period_end to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property changed_resources/subscriptions/items/trial_end to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property subscription/coupon_associations/items/coupon/coupon_code to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property subscription/coupon_associations/items/subscription_line_item to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property subscription/customer/integrations/items/metadata to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property subscription/customer/timezone to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property subscription/line_items/items/commitment_time_buckets to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property subscription/line_items/items/price/sequence to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property subscription/synced_price_sequence to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property subscription/timezone to the response with the 200 status

      response-optional-property-added

  • f62d8a5fe7cf61See the full diff
    • ●

      removed the optional property details from the response with the 400 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 404 status

      response-optional-property-removed

    • ●

      removed the optional property details from the response with the 500 status

      response-optional-property-removed

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

      added the new too_many_requests enum value to the code response property for the response status 500

      response-property-enum-value-added

    • ○

      added the optional property changed_resources/invoices/items/invoice/issue_date to the response with the 200 status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0cb3425d65801535See the full diff
    • ▲

      added the new required request property type

      new-required-request-property

    • ●

      removed the request property external_customer_ids_to_inherit_subscription

      request-property-removed

    • ●

      removed the optional property active_pause_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property billing_anchor from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property billing_cadence from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property billing_cycle from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property billing_period from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property billing_period_count from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property cancel_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property cancel_at_period_end from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property cancelled_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property collection_method from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property commitment_amount from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property commitment_duration from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property coupon_associations from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property created_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property created_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property credit_grants from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property currency from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property current_period_end from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property current_period_start from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property customer from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property customer_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property customer_timezone from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property enable_true_up from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property end_date from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property environment_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property gateway_payment_method_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property invoicing_customer_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property latest_invoice from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property line_items from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property lookup_key from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property metadata from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property overage_factor from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property parent_subscription_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property pause_status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property pauses from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property payment_behavior from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property payment_terms from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property phases from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property plan from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property plan_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property proration_behavior from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property start_date from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property subscription_status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property subscription_type from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property tenant_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property trial_end from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property trial_start from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property updated_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property updated_by from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property version from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property grouped_invoicing_params

      new-optional-request-property

    • ○

      added the new optional request property inheritance_params

      new-optional-request-property

    • ○

      added the new optional request property quantity_change_params

      new-optional-request-property

    • ○

      added the optional property changed_resources to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property subscription to the response with the 200 status

      response-optional-property-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 82f205e0f42922See the full diff
    • ●

      removed the optional property line_items/items/price/trial_period from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property line_items/items/trial_period from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property line_items/items/price/trial_period_days to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property line_items/items/trial_period_days to the response with the 200 status

      response-optional-property-added

  • 4ded3711f4011See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog