Subscription Notes

List Subscription Notes

GET
/subscriptions/{subscription_id}/notes.json

Retrieves a list of notes associated with a subscription. The response will be an array of Notes.

Authorization

BasicAuth
AuthorizationBasic <token>

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

In: header

Path Parameters

subscription_id*integer

The Chargify id of the subscription.

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/subscriptions/0/notes.json"
[  {    "note": {      "body": "Test note.",      "created_at": "2015-06-15T13:26:47-04:00",      "id": 5,      "sticky": false,      "subscription_id": 100046,      "updated_at": "2015-06-15T13:28:12-04:00"    }  },  {    "note": {      "body": "Another test note.",      "created_at": "2015-06-15T12:04:46-04:00",      "id": 4,      "sticky": false,      "subscription_id": 100046,      "updated_at": "2015-06-15T13:26:33-04:00"    }  }]