RESOURCE | Credits

GET '/credits'

Returns your account's current Dielines API credit balance. This is read-only — calling it never spends a credit. Use it to check how many dieline generations you have left and when your credits expire.

Request Parameters

None.

Response Object

Returns a credits object.

Objects | credits

This object represents your account's current API credit balance for a single product.

type string "credits"
product string Which product this balance is for: "dielines" or "dimensions".
available integer The number of active credits — unexpired and not yet spent — you can use right now. 0 when you have none.
expires_at string | null When your furthest-out active credit expires, as an ISO 8601 UTC timestamp (for example "2027-03-14T09:20:00Z"). null when available is 0.
borrowed integer "dielines" only. The credits borrowed from next month's credits after your credits ran out. Your next monthly credits are reduced by this number. 0 when nothing is borrowed.
borrowable integer "dielines" only. How many more credits can be borrowed from next month's credits once available is 0. Set the percentage, or turn borrowing off, on your Dielines API settings page. 0 when borrowing is off, the limit is reached, or you have no monthly Dielines API subscription.
unlimited boolean Present, and always true, only when your account is granted unlimited access and generates without spending credits — do not read available = 0 as "out of credits". Omitted entirely for ordinary credit-based accounts.

Example Response, Status = 200

application/json
{
  "credits": {
    "type": "credits",
    "product": "dielines",
    "available": 137,
    "expires_at": "2027-03-14T09:20:00Z",
    "borrowed": 0,
    "borrowable": 6
  }
}