Billing
GET Billings#
Get payment details.
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/organizations/{organizationId}/billings |
| Headers | Authorization |
| Parameters | organizationId, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {organizationId} | Yes | string | "string" | Shows the identifier for organization |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string($uuid) | v1 | Shows the version of API |
| organizationId | Yes | string | "string" | Shows the identifier for organization |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "brand": "string", "country": "string", "funding": "string", "expMonth": 0, "expYear": 0, "last4": "string"}
| Field Name | Type | Example | Description |
|---|---|---|---|
| brand | string | "string" | |
| country | string | "string" | |
| funding | string | "string" | |
| expMonth | integer($int32) | 0 | |
| expYear | integer($int32) | 0 | |
| last4 | string | "string" |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
DELETE Organization#
Remove organization default payment.
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api​/v{version}​/organizations​/{organizationId}​/billings |
| Headers | Authorization |
| Parameters | organizationId, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {organizationId} | Yes | string | v1 | The identifier for the organization |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| Version | Yes | string | v1 | Shows the version of API |
| organizationId | Yes | string($uuid) | 1 | The identifier for the organization |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "brand": "string", "country": "string", "funding": "string", "expMonth": 0, "expYear": 0, "last4": "string"}
| Field Name | Type | Example | Description |
|---|---|---|---|
| brand | string | "string" | |
| country | string | "string" | |
| funding | string | "string" | |
| expMonth | integer($int32) | 0 | |
| expYear | integer($int32) | 0 | |
| last4 | string | "string" |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found