Accesses your billing history object.
/user/billing/history
get
User Billing History
user-billing-history-(-deprecated)-billing-history-details
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"#billing:read"
]
}[
{
"in": "query",
"name": "page",
"schema": {
"default": 1,
"description": "Page number of paginated results.",
"minimum": 1,
"type": "number"
}
},
{
"in": "query",
"name": "per_page",
"schema": {
"default": 20,
"description": "Number of items per page.",
"maximum": 50,
"minimum": 5,
"type": "number"
}
},
{
"in": "query",
"name": "order",
"schema": {
"description": "Field to order billing history by.",
"enum": [
"type",
"occured_at",
"action"
],
"example": "occured_at",
"type": "string"
}
},
{
"in": "query",
"name": "occured_at",
"schema": {
"description": "When the billing item was created.",
"example": "2014-03-01T12:21:59.3456Z",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "occurred_at",
"schema": {
"description": "When the billing item was created.",
"example": "2014-03-01T12:21:59.3456Z",
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "type",
"schema": {
"description": "The billing item type.",
"example": "charge",
"maxLength": 30,
"readOnly": true,
"type": "string"
}
},
{
"in": "query",
"name": "action",
"schema": {
"description": "The billing item action.",
"example": "subscription",
"maxLength": 30,
"readOnly": true,
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"action": {
"description": "The billing item action.",
"example": "subscription",
"maxLength": 30,
"readOnly": true,
"type": "string"
},
"amount": {
"description": "The amount associated with this billing item.",
"example": 20.99,
"readOnly": true,
"type": "number"
},
"currency": {
"description": "The monetary unit in which pricing information is displayed.",
"example": "USD",
"readOnly": true,
"type": "string"
},
"description": {
"description": "The billing item description.",
"example": "The billing item description",
"maxLength": 255,
"readOnly": true,
"type": "string"
},
"id": {
"description": "Billing item identifier tag.",
"example": "b69a9f3492637782896352daae219e7d",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"occurred_at": {
"description": "When the billing item was created.",
"example": "2014-03-01T12:21:59.3456Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The billing item type.",
"example": "charge",
"maxLength": 30,
"readOnly": true,
"type": "string"
},
"zone": {
"properties": {
"name": {
"readOnly": true
}
},
"type": "object"
}
},
"required": [
"id",
"type",
"action",
"description",
"occurred_at",
"amount",
"currency",
"zone"
],
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "Billing History Details response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"properties": {
"action": {
"description": "The billing item action.",
"example": "subscription",
"maxLength": 30,
"readOnly": true,
"type": "string"
},
"amount": {
"description": "The amount associated with this billing item.",
"example": 20.99,
"readOnly": true,
"type": "number"
},
"currency": {
"description": "The monetary unit in which pricing information is displayed.",
"example": "USD",
"readOnly": true,
"type": "string"
},
"description": {
"description": "The billing item description.",
"example": "The billing item description",
"maxLength": 255,
"readOnly": true,
"type": "string"
},
"id": {
"description": "Billing item identifier tag.",
"example": "b69a9f3492637782896352daae219e7d",
"maxLength": 32,
"readOnly": true,
"type": "string"
},
"occurred_at": {
"description": "When the billing item was created.",
"example": "2014-03-01T12:21:59.3456Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The billing item type.",
"example": "charge",
"maxLength": 30,
"readOnly": true,
"type": "string"
},
"zone": {
"properties": {
"name": {
"readOnly": true
}
},
"type": "object"
}
},
"required": [
"id",
"type",
"action",
"description",
"occurred_at",
"amount",
"currency",
"zone"
],
"type": "object"
},
"type": "array"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Billing History Details response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]