Reason Codes

List Reason Codes

GET
/reason_codes.json

Lists all current churn codes for a given site.

Authorization

BasicAuth
AuthorizationBasic <token>

The username is a Maxio Chargify API key. The password is x.

In: header

Query Parameters

page?integer

Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query page=1.

Range1 <= value
Default1
per_page?integer

This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200. Use in query per_page=200.

Rangevalue <= 200
Default20

Response Body

application/json

application/json

curl -X GET "https://example.com/reason_codes.json"
[  {    "reason_code": {      "id": 2,      "site_id": 2,      "code": "LARGE",      "description": "This is too complicated",      "position": 1,      "created_at": "2017-02-16T16:49:07-05:00",      "updated_at": "2017-02-17T16:29:51-05:00"    }  },  {    "reason_code": {      "id": 1,      "site_id": 2,      "code": "CH1",      "description": "This does not meet my needs",      "position": 2,      "created_at": "2017-02-16T16:48:45-05:00",      "updated_at": "2017-02-17T16:29:59-05:00"    }  },  {    "reason_code": {      "id": 5,      "site_id": 2,      "code": "HAN99",      "description": "Hard to setup",      "position": 3,      "created_at": "2017-02-17T16:29:42-05:00",      "updated_at": "2017-02-17T16:29:59-05:00"    }  }]