Checkout Sessions

Cancel a checkout session

Changed on
post/api/v1/checkout-sessions/{id}/cancel

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Path parameters

idstring MeteroidId required
Example:che_7n42DGM5Tflk9n8mt7Fhc7

Checkout session ID

Response

Checkout session cancelled

Example response

{
  "session": {
    "customer_id": "cus_7n42DGM5Tflk9n8mt7Fhc7",
    "id": "che_7n42DGM5Tflk9n8mt7Fhc7",
    "payment_methods_config": {
      "account_id": "ba_7n42DGM5Tflk9n8mt7Fhc7"
    },
    "plan_version_id": "plv_7n42DGM5Tflk9n8mt7Fhc7",
    "subscription_id": "sub_7n42DGM5Tflk9n8mt7Fhc7"
  }
}

Changes

  • v1560215310a09Revision changes
    • breaking

      added to the ///// response property oneOf list for the response status

    • info

      added discriminator to ///// response property for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 from the ///// response property oneOf list for the response status

  • v1de35c02bb0d2Revision changes
    • breaking

      for the path request parameter id, the format changed from no format to MeteroidId

    • breaking

      added subschema #1 to the /////// response property oneOf list for the response status

    • breaking

      the /////// response's property type changed from string null to no type for status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • warning

      added the new TOO_MANY_REQUESTS enum value to the response property for the response status

    • info

      added the non-success response with the status