Subscriptions

Execute subscription plan change

Changed on

Use when applying a plan change (e.g. upgrade or downgrade). Executes proration and generates invoice or credit as needed.

post/subscriptions/{id}/change/execute

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/subscriptions/{id}/change/execute
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Subscription ID

Request body

billing_cadence'RECURRING' required
billing_cycle'anniversary' | 'calendar' required
billing_period'MONTHLY' | 'ANNUAL' | 'WEEKLY' | 'DAILY' | 'QUARTERLY' | 'HALF_YEARLY' | 'ONETIME' required
billing_period_countinteger

billing_period_count is the billing period count for the new subscription

change_at'immediate' | 'end_of_period'
metadataobject

metadata contains additional key-value pairs for storing extra information

proration_behavior'create_prorations' | 'none' required
target_plan_idstring required

target_plan_id is the ID of the new plan to change to (required)

Response

OK

change_type'upgrade' | 'downgrade' | 'lateral'
effective_datestring date-time

effective_date is when the change took effect

is_scheduledboolean

is_scheduled indicates if the change was scheduled or executed immediately

metadataobject

metadata from the request

schedule_idstring

schedule_id is the ID of the created schedule (only if is_scheduled=true)

scheduled_atstring date-time

scheduled_at is when the change will execute (only if is_scheduled=true)

Changes

  • 84cb4a3af400Revision changes
    • info

      added the optional property / to the response with the status

  • 3798546cc4a3Revision changes
    • warning

      added the new END_OF_MONTH enum value to the // response property for the response status

    • warning

      added the new END_OF_NEXT_MONTH enum value to the // response property for the response status

    • warning

      added the new credit_note enum value to the /// response property for the response status

    • warning

      added the new not_collecting enum value to the / response property for the response status

    • warning

      added the new not_collecting enum value to the /// response property for the response status

    • warning

      added the new not_subject_to_tax enum value to the / response property for the response status

    • warning

      added the new not_subject_to_tax enum value to the /// response property for the response status

    • warning

      added the new not_supported enum value to the / response property for the response status

    • warning

      added the new not_supported enum value to the /// response property for the response status

    • warning

      added the new reverse_charge enum value to the / response property for the response status

    • warning

      added the new reverse_charge enum value to the /// response property for the response status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status