---
title: "Get your credits"
method: GET
path: "/v1/credits"
tags: ["Unlocks and reports"]
---

# Get your credits

`GET /v1/credits`

## Request

- Base URL: `https://app.propcode.com.au/api`
- URL: `https://app.propcode.com.au/api/v1/credits`
- Auth: HTTP bearer

What your team has to unlock properties with, by credit type: Pro credits from Property Packs, Max's daily allowance (dailyAllowance) when it has Max, and the CDC report and Rapid Planning Report credits of a plan from before Core and Pro. Free.

## Response `200`

Your team's credits.

- Credits: What your team has to unlock properties with, by credit type.
  - `object` 'credits', required
  - `pro` object, required: Pro credits from Property Packs, shared by your team.
    - `remaining` integer, required: Pro credits left in your team's Property Packs.
  - `dailyAllowance` object, nullable, required: Max Pro's unlocks for today, shared by your team's seats and spent before any pack; null without Max.
    - `limit` integer, required: Today's unlocks: 20 for each Max seat.
    - `used` integer, required: Unlocks used today.
    - `remaining` integer, required: Unlocks left today.
    - `resetsAt` string, required: When the allowance starts again in full: the next midnight in Sydney (ISO 8601).
  - `cdc` object, required: CDC report credits from a plan from before Core and Pro: each unlocks a property's CDC report (creditType cdc).
    - `remaining` integer, required: CDC report credits left; 0 when your team has none.
  - `rpr` object, required: Rapid Planning Report credits from a plan from before Core and Pro: each unlocks a property's Rapid Planning Report (creditType rpr).
    - `remaining` integer, required: Rapid Planning Report credits left; 0 when your team has none.
  - `choices` PurchaseChoice[]: When your team has nothing to unlock a property with, and you're its owner or an admin: what you can buy in PropCode, with links.
    - `name` string, required: What it buys: "Just this property" or "Property Pack".
    - `price` string: Its price with GST, from PropCode's live catalog: e.g. A$82.50, or from A$27.50 a property for a pack. Left out when the catalog can't be read.
    - `url` string, required: PropCode's checkout, opened on this choice. The person buys there; an agent never buys.
  - `note` string: When your team has nothing to unlock a property with: who buys credits, in a sentence or two to pass on to the person.

## Other responses

- `400`: The request isn’t valid. Codes: `key_in_url`.
- `401`: No valid key. Codes: `missing_api_key`, `invalid_api_key`.
- `403`: This key can’t ask that. Codes: `key_owner_left`.
- `429`: Over a limit: retry after Retry-After. Codes: `rate_limited`, `sandbox_daily_limit`.
- `500`: Our error. Codes: `internal_error`.

---

[API](https://skmtc.dev/propcode/apis/propcode-api.md) - [All operations](https://skmtc.dev/propcode/apis/propcode-api/llms.txt) - [OpenAPI document](https://skmtc.dev/propcode/apis/propcode-api/revisions/f393cce32349?raw)