Card
Manage Billing Cards.
Create
Add a credit card
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| current | boolean | |
| name | string | yes |
| number | string | yes |
| month | string | yes |
| year | string | yes |
| stripeToken | string | yes |
Response
| Field | Type |
|---|---|
| accountId | string |
| current | boolean |
| error | string |
| failures | number |
| id | string |
| name | string |
| number | string |
| month | string |
| submitted | date |
| year | string |
Find
Get a list of all the cards added
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
A object.
Query String Options
| Field | Type |
|---|---|
| hidden | boolean |
| filter | string |
| limit | number |
| next | object |
| prev | object |
| index | string |
| where | string |
| log | boolean |
Response
Paged response.
| Field | Type | Notes |
|---|---|---|
| data | array | A list of cards. |
| next | string | Paged cursor to use for the next page of items. |
| prev | string | Pages cursor to use for the previous page of items. |
Card
An array of Card items.
| Field | Type |
|---|---|
| accountId | string |
| current | boolean |
| error | string |
| failures | number |
| id | string |
| name | string |
| number | string |
| month | string |
| submitted | date |
| year | string |
Get
Get a card by ID
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| id | string | yes |
Response
The requested card.
| Field | Type |
|---|---|
| accountId | string |
| current | boolean |
| error | string |
| failures | number |
| id | string |
| name | string |
| number | string |
| month | string |
| submitted | date |
| year | string |
Init
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
A object.
Response
| Field | Type |
|---|---|
| accountId | string |
| current | boolean |
| error | string |
| failures | number |
| id | string |
| name | string |
| number | string |
| month | string |
| submitted | date |
| year | string |
Remove
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| id | string | yes |
Response
| Field | Type |
|---|---|
| accountId | string |
| current | boolean |
| error | string |
| failures | number |
| id | string |
| name | string |
| number | string |
| month | string |
| submitted | date |
| year | string |
UpdateCurrent
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| id | string | yes |
| current | boolean |
Response
| Field | Type |
|---|---|
| accountId | string |
| current | boolean |
| error | string |
| failures | number |
| id | string |
| name | string |
| number | string |
| month | string |
| submitted | date |
| year | string |
GetStripe
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
A object.
Response
A stripe token.
| Field | Type |
|---|---|
| 0 | any |
| 1 | any |
| 2 | any |
| 3 | any |
| 4 | any |
| 5 | any |