General Silver API specifications
Here is an overview of the Silver API. You can find useful information about how to paginate the results and iterate through the entire collection.
For resource definition check out the Resources page.
Listing
Requests that return multiple items are paginated by default to 30 items. You can specify the page parameter for the page number and per_page to increase/decrease the items per page. There is a hard limit of items per page of 100. The page numbering is 1-based and if you do not specify a page parameter it’s default value is 1.
NOTE
Note that not all listings can be iterated using
pageparameters and some ignore the page parameter.
Iterating entire collection
In order to iterate the entire collection you must follow the Link header.
Link: <https://api.example.com/silver/subscriptions?page=3&per_page=100>; rel="next",
<https://api.example.com/silver/subscriptions?page=last&per_page=100>; rel="last"
The possible rel values are:
| Name | Description |
|---|---|
| next | Shows the URL of the immediate next page of results. |
| last | Shows the URL of the last page of results. |
| first | Shows the URL of the first page of results. |
| prev | Shows the URL of the immediate previous page of results. |
See Also
Payment Methods in Silver
Detailed explanations of what is a Payment Method in Silver, how to retrieve and create one, as well [...]
Payment Processors in Silver
Detailed explanations of what is a Payment Processor in Silver, as well as how to list a provider's [...]
Payments in Silver
An overview of what is a Payment in Silver, listing a customer's payments or retrieving a specific [...]