Get billing cycles¶
Returns billing cycles
Prerequisites¶
Credentials as described in Authentication
C#¶
To get asset, first create the instance of CrayonApiClient and get token using the instance.
Then call BillingCycles.Get() method to get billing cycles by passing token and optional includeUnknown boolean.
var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var includeUnknown = <optional bool, false by default>;
var result = client.BillingCycles.GetById(token, includeUnknown);
Request¶
Request Syntax:
Method |
Request URI |
---|---|
GET |
https://api.crayon.com/api/v1/billingcycles/?includeUnknown=true |
Request Parameters:
Name |
Type |
Description |
---|---|---|
includeUnknown |
bool? |
Optional (default: false). Specifies whether to include billing cycles from unknown publishers. |
Request Headers:
The following HTTP request headers are supported
Header |
Type |
Description |
|
---|---|---|---|
Authorization |
string |
Required. The authorization token in the form Bearer <token>. |
|
Accept |
string |
Specifies the request and response type, “application/json”. |
|
Content-Type |
string |
Specifies the media type of the resource, “application/json”. |
Request Example:
GET $"https://api.crayon.com/api/v1/billingcycles/?includeUnknown=true"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >
Response¶
If successful, this method returns a collection of billing cycles in the response body.
[
{
"Id": 0,
"Name": "Unknown"
},
{
"Id": 1,
"Name": "Monthly"
},
{
"Id": 2,
"Name": "Annual"
},
{
"Id": 3,
"Name": "None"
},
{
"Id": 4,
"Name": "OneTime"
},
{
"Id": 5,
"Name": "BiAnnually"
},
{
"Id": 7,
"Name": "TwoYears"
},
{
"Id": 8,
"Name": "ThreeYears"
},
{
"Id": 9,
"Name": "Quarterly"
}
]
Response success and error codes:
Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.
Error Codes |
Description |
---|---|
200 Ok |
The request has succeeded. |
401 Unauthorized |
The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition. |