tx-agent-kit
API Reference

billing Endpoints

API endpoints for the billing resource group

billing Endpoints

GET /v1/organizations/{organizationId}/billing

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

PATCH /v1/organizations/{organizationId}/billing

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/billing/checkout

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/billing/portal

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/billing/{organizationId}/top-up

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/billing/{organizationId}/dev/complete-local

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/organizations/{organizationId}/usage

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---
categoryquerystringYes---
periodStartquerystringNo---
periodEndquerystringNo---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/billing/{organizationId}/credits

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/billing/{organizationId}/credits/history

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---
limitquerystringNo---
cursorquerystringNo---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/billing/{organizationId}/no-cap-reminder

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/billing/{organizationId}/no-cap-reminder/dismiss

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

GET /v1/billing/{organizationId}/auto-recharge/requires-action

Parameters

NameInTypeRequiredDescription
organizationIdpathstringYes---

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

POST /v1/webhooks/stripe

Responses

StatusDescription
200Success
400The request did not match the expected schema
401Unauthorized
402PaymentRequired
403Forbidden
404NotFound
409Conflict
429TooManyRequests
500InternalError

teams Endpoints

API endpoints for the teams resource group

permissions Endpoints

API endpoints for the permissions resource group

On this page

billing EndpointsGET /v1/organizations/{organizationId}/billingParametersResponsesPATCH /v1/organizations/{organizationId}/billingParametersResponsesPOST /v1/billing/checkoutResponsesPOST /v1/billing/portalResponsesPOST /v1/billing/{organizationId}/top-upParametersResponsesPOST /v1/billing/{organizationId}/dev/complete-localParametersResponsesGET /v1/organizations/{organizationId}/usageParametersResponsesGET /v1/billing/{organizationId}/creditsParametersResponsesGET /v1/billing/{organizationId}/credits/historyParametersResponsesGET /v1/billing/{organizationId}/no-cap-reminderParametersResponsesPOST /v1/billing/{organizationId}/no-cap-reminder/dismissParametersResponsesGET /v1/billing/{organizationId}/auto-recharge/requires-actionParametersResponsesPOST /v1/webhooks/stripeResponses