Credits

Endpoints related to credits applied to a hub.

List Billing Credits

Lists the Billing Credits associated with the current Hub.

Requires the billing-credits-view capability.

SecuritybearerAuth and hubAuth

Request

query Parameters

sort	Array of strings An array of sort values. To sort descending, put a `-` in front of the value, e.g. `-id`.
	object Filter Field The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
	object In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be `page[size]=20&page[number]=2`

Responses

200

Returns a collection of credit resources.

default

General error response from the platform

get/v1/billing/credits

Response samples

200
default

application/json

{"data": [{"id": "651586fca6078e98982dbd90",
"hub_id": "651586fca6078e98982dbd90",
"description": "string",
"account_id": "string",
"amount": 0,
"amount_remaining": 0,
"expires": {"date": "2021-01-30T08:30:00Z"
},
"events": {"created": "2021-01-30T08:30:00Z",
"updated": "2021-01-30T08:30:00Z",
"deleted": "2021-01-30T08:30:00Z"
},
"state": {"changed": "2021-01-30T08:30:00Z",
"error": {"message": "string",
"time": "2021-01-30T08:30:00Z"
}
}
}
]
}

Get Billing Credit

Requires the billing-credits-view capability.

SecuritybearerAuth and hubAuth

Request

path Parameters

creditsId

required

string

The ID for a given credit.