Get Reasons

Gets available subscription action reasons for the given category. If no category is supplied will give available Cancel action reasons.

GET /commerce/subscriptions/reasons

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "name": "<string>",
      "needsMoreInfo": true,
      "reasonCode": "<string>"
    }
  ],
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

category · string · default: CANCEL

Action to get available reasons for. Defaults to CANCEL

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

Success

items · object[] | null

Show child attributes

totalCount · integer<int32>