SCschematichq
checkout

Pause subscription

Changed on
post/manage-plan/subscription/pause

Request

  • Base URL
    https://api.schematichq.com
  • Auth
    API key in header X-Schematic-Api-Key

Request body

company_idstring required
monthsinteger required

How many months to pause for, counted from the end of the current billing period. Between 1 and 6.

subscription_external_idstring nullable

The payment provider's ID for the subscription to pause. Required when the company has more than one subscription; otherwise defaults to its only one.

Response

OK

paramsobject required

Input parameters

Changes

  • 341af90aac66Revision changes
    • info

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

    • info

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

  • 9f718796c78dRevision changes
    • info

      added the optional property / to the response with the status