Sign Customiser

Navigation

Dark mode

Returns the rules the merchant admin prices a custom AI credit purchase with, and whether the Store's next purchase earns the referral bonus. Requires billing:read.

GET/api/v3/stores/me/credit-pricing
GETGet the Store credit pricing
GET/api/v3/stores/me/credit-pricing

Get the Store credit pricing

Returns the rules the merchant admin prices a custom AI credit purchase with, and whether the Store's next purchase earns the referral bonus. Requires `billing:read`. The API cannot buy credits: the merchant buys them in the merchant admin, which quotes the total again on purchase. A purchase is a number of credits from `min_credits` to `max_credits`, in steps of `credit_step`. Each credit costs `base_unit_amount` in `currency`. A purchase of `volume_threshold_credits` or more gets `volume_discount_percent` off. This endpoint accepts no query parameters.

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Get the Store credit pricing

Click Send to see the live response.

Overview

The API cannot buy credits: the merchant buys them in the merchant admin, which quotes the total again on purchase. A purchase is a number of credits from min_credits to max_credits, in steps of credit_step. Each credit costs base_unit_amount in currency. A purchase of volume_threshold_credits or more gets volume_discount_percent off. This endpoint accepts no query parameters.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: billing:read

Get the Store credit pricing
curl https://web.signcustomiser.com/api/v3/stores/me/credit-pricing \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "credit_pricing",
    "min_credits": 20,
    "max_credits": 1000,
    "credit_step": 10,
    "base_unit_amount": 25,
    "currency": "USD",
    "volume_threshold_credits": 120,
    "volume_discount_percent": 10,
    "referral_bonus_percent": 50,
    "referral_bonus": {
      "applies": false,
      "can_add_code": true,
      "from_saved_code": false
    }
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/stores/me/credit-pricing",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.