Apply Coupon
Apply a promotional coupon code to the project’s billing account.
Authorizations
Service Account Token authentication. To authenticate API requests:
-
Create a Service Account Token:
- Go to the Cerebrium Dashboard and open the API Keys page
- Click Create Service Account, name it (e.g., "GitHub Actions CI/CD"), choose an expiry date, and click Create
- Copy the token generated for the desired service account
-
Use the Token: Include the service account token in the Authorization header of API requests:
Authorization: Bearer <your-service-account-token> -
Best Practices:
- Create separate service accounts for different environments (dev, staging, prod)
- Store tokens securely as secrets in consuming applications or workflows
- Set appropriate expiry dates and rotate tokens regularly
- Never commit tokens to source control
For CI/CD integration examples, see the CI/CD documentation.
Path Parameters
Body
The promotional coupon code to apply
Response
Confirmation that the coupon was applied, with the applied coupon's details.
Details of the applied coupon. Contains code (string), name (string), amount_cents (integer), amount_currency (string), frequency (string), expiration_at (string timestamp, omitted if the coupon does not expire), percentage_rate (number, omitted for fixed-amount coupons), and amount_cents_balance (integer of remaining credit in cents).
Human-readable confirmation message.
Whether the coupon was applied successfully.