Billing endpoints¶
Generated from the central API contract. Availability and permissions are checked by the connected service.
GET /v1/billing¶
Plan and credits: plan credits, trial, purchased
Authorization: usage:read Current resource access and role checks also apply.
MCP: get_billing
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/billing"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/billing/topups¶
A Stripe Checkout link to buy Developer credits (open it in a browser)
Authorization: billing:write Current resource access and role checks also apply.
MCP: create_topup_link
Request body: application/json — TopUp or null. Optional.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/billing/topups"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/billing/developer¶
Switch a free trial to Developer (pay as you go)
Authorization: billing:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/billing/developer"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/billing/trial¶
A Stripe Checkout link to start the free trial with a card (nothing is charged during it)
Authorization: billing:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/billing/trial"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/billing/card¶
A Stripe Checkout link to save a card: Developer is then billed monthly for what it uses
Authorization: billing:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/billing/card"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/billing/checkout¶
A Stripe Checkout link to subscribe to Core
Authorization: billing:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Request body: application/json — PlanCheckout. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/billing/checkout"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/billing/checkout/complete¶
Record a returned Stripe Checkout (credits or Core) in case the webhook is missed
Authorization: billing:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Request body: application/json — CheckoutReturn. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/billing/checkout/complete"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/billing/portal¶
A Stripe billing portal link
Authorization: billing:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/billing/portal"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
GET /v1/billing/subscription¶
The Core subscription: monthly or annual, when it renews or ends, any switch waiting
Authorization: usage:read Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X GET \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/billing/subscription"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/billing/subscription/cycle¶
Bill Core monthly or annually (annual now; monthly when the paid year ends)
Authorization: billing:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Request body: application/json — CycleChange. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/billing/subscription/cycle"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/billing/subscription/cancel¶
Cancel Core at the end of the current period (resume any time before then)
Authorization: billing:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/billing/subscription/cancel"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
POST /v1/billing/subscription/resume¶
Keep a cancelled Core subscription
Authorization: billing:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X POST \
-H "Authorization: Bearer $GD_API_KEY" \
"$GD_API_BASE/v1/billing/subscription/resume"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.
PUT /v1/billing/spending-limit¶
Set Core’s monthly limit on extra credits
Authorization: billing:write Current resource access and role checks also apply.
MCP: No dedicated tool in the current catalogue; use REST with the required permissions.
Request body: application/json — SpendingLimit. Required.
HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.
curl --fail-with-body --silent --show-error -X PUT \
-H "Authorization: Bearer $GD_API_KEY" \
-H "Content-Type: application/json" \
--data-binary @request.json \
"$GD_API_BASE/v1/billing/spending-limit"
HTTP status |
Response schema |
|---|---|
|
JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.