checkout

Cancel subscription

Changed on
post/manage-plan/subscription/cancel

Request

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

Request body

cancel_immediatelyboolean nullable

If false, subscription cancels at period end. Defaults to true.

company_idstring required
prorateboolean nullable

If true and cancel_immediately is true, issue prorated credit. Defaults to true.

Response

OK

paramsobject required

Input parameters

Changes

  • 6d4b96940aadRevision changes
    • info

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

  • ce7c5cc627adRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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