Skip to content
AdVentur.aiAdVentur.aiAdVentur.ai Docs

Billing API

Plan, subscription, invoices and usage credits.

11 endpoints. Every path is relative to the API base URL and needs a bearer token unless it is marked public. See the REST API overview for authentication, errors and pagination.

GET/v1/orgs/{orgId}/billing

Bearer token

Path parameters

  • orgIdstring (uuid)required

Responses

200
  • dataobjectrequired
    Fields
    • planobject | nullrequired
      Fields
      • idstring (uuid)required
      • keystringrequired
      • namestringrequired
      • monthlyPricenumber | nullrequired
      • monthlyCreditsnumberrequired
      • teamsEnabledbooleanrequired
      • maxMembersnumberrequired
    • subscriptionobject | nullrequired
      Fields
      • idstring (uuid)required
      • statusstringrequired

        one of active, pausing, paused, past_due, canceled, trialing

      • accessStatestringrequired

        one of full, read_only

      • trialEndsAtstring | nullrequired
      • trialDaysRemaininginteger | nullrequired
      • isTrialExpiredbooleanrequired
      • canChangePlanbooleanrequired
      • canPausebooleanrequired
      • pastDueSincestring | nullrequired
      • graceEndsAtstring | nullrequired
      • billingIntervalstringrequired
      • currentPeriodStartstring | nullrequired
      • currentPeriodEndstring | nullrequired
      • cancelAtPeriodEndboolean | nullrequired
      • paddleCustomerIdstring | nullrequired
      • hasPaddleSubscriptionbooleanrequired
    • trialDurationDaysintegerrequired
    • creditBalanceobjectrequired
      Fields
      • monthlynumberrequired
      • purchasednumberrequired
      • allowancenumberrequired
      • totalnumberrequired
      • rollovernumber
    • usageSummaryobjectrequired
      Fields
      • periodStartstringrequired
      • periodEndstringrequired
      • periodUsedCreditsnumberrequired
      • periodAllowanceCreditsnumberrequired
      • periodPurchasedCreditsnumberrequired
      • periodBudgetCreditsnumberrequired
      • periodRemainingCreditsnumberrequired
      • usagePercentnumberrequired
    • creditActionCostsarray<object>required
      Item fields
      • keystringrequired
      • labelstringrequired
      • descriptionstringrequired
      • creditsintegerrequired
    • recentCreditTransactionsarray<object>required
      Item fields
      • idstring (uuid)required
      • typestringrequired
      • amountnumberrequired
      • monthlyCreditsAfternumberrequired
      • purchasedCreditsAfternumberrequired
      • metadataobject | nullrequired
      • createdAtstringrequired
    • recentBillingTransactionsarray<object>required
      Item fields
      • idstring (uuid)required
      • typestringrequired
      • amountnumberrequired
      • currencystringrequired
      • statusstringrequired
      • invoiceUrlstring | nullrequired
      • paidAtstring | nullrequired
      • createdAtstringrequired
    • recentSubscriptionEventsarray<object>required
      Item fields
      • idstring (uuid)required
      • typestringrequired

        one of pausing, paused, resumed

      • createdAtstringrequired
    • recentInvoicesarray<object>required
      Item fields
      • idstring (uuid)required
      • statusstringrequired
      • totalnumberrequired
      • currencystringrequired
      • invoiceUrlstring | nullrequired
      • paidAtstring | nullrequired
      • createdAtstringrequired
    • paddleCreditBalancearray<object>
      Item fields
      • currencyCodestringrequired
      • availableCentsnumberrequired
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/billing" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/billing/change-plan

Bearer token

Path parameters

  • orgIdstring (uuid)required

Request body application/json

  • priceIdstringrequired

Responses

200
  • dataobjectrequired
    Fields
    • updatedbooleanrequired
    • messagestringrequired
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/billing/change-plan" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"priceId":"string"}'

GET/v1/orgs/{orgId}/billing/checkout-data

Bearer token

Path parameters

  • orgIdstring (uuid)required

Responses

200
  • dataobjectrequired
    Fields
    • paddleCustomerIdstring | nullrequired
    • trialDurationDaysintegerrequired
    • plansarray<object>required
      Item fields
      • keystringrequired
      • namestringrequired
      • paddlePriceIdstring | nullrequired
      • paddlePriceIdAnnualstring | nullrequired
      • monthlyPricenumber | nullrequired
      • annualPricenumber | nullrequired
      • monthlyCreditsnumberrequired
      • teamsEnabledbooleanrequired
      • maxMembersnumberrequired
      • localizedCurrencyCodestring | null
      • localizedMonthlyPricenumber | null
      • localizedMonthlyPriceFormattedstring | null
      • localizedAnnualPricenumber | null
      • localizedAnnualPriceFormattedstring | null
    • creditPacksarray<object>required
      Item fields
      • keystringrequired
      • namestringrequired
      • paddlePriceIdstring | nullrequired
      • creditsnumberrequired
      • pricenumberrequired
      • localizedCurrencyCodestring | null
      • localizedPricenumber | null
      • localizedPriceFormattedstring | null
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/billing/checkout-data" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

GET/v1/orgs/{orgId}/billing/credits/usage

Bearer token

Path parameters

  • orgIdstring (uuid)required

Query parameters

  • pageinteger
  • limitinteger
  • metricKeystring
  • featurestring
  • modelstring
  • createdAtFromstring
  • createdAtTostring

Responses

200
  • dataobjectrequired
    Fields
    • dataarray<object>required
      Item fields
      • idstring (uuid)required
      • metricKeystringrequired
      • quantitynumberrequired
      • typestring | nullrequired
      • featurestring | nullrequired
      • providerstring | nullrequired
      • modelstring | nullrequired
      • inputTokensnumber | nullrequired
      • outputTokensnumber | nullrequired
      • totalTokensnumber | nullrequired
      • amountUsednumberrequired
      • creditsUsedMillinumber | nullrequired
      • pricingVersionstring | nullrequired
      • usedFallbackEstimatebooleanrequired
      • monthlyCreditsAfternumber | nullrequired
      • purchasedCreditsAfternumber | nullrequired
      • metadataobject | nullrequired
      • createdAtstringrequired
    • metadataobjectrequired
      Fields
      • pageintegerrequired
      • limitintegerrequired
      • totalintegerrequired
      • totalPagesintegerrequired
      • hasNextbooleanrequired
      • hasPrevbooleanrequired
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/billing/credits/usage" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

GET/v1/orgs/{orgId}/billing/invoices

Bearer token

Path parameters

  • orgIdstring (uuid)required

Query parameters

  • pageinteger
  • limitinteger
  • sortBystring

    one of createdAt, amount, status

  • sortDirstring

    one of asc, desc

  • filterobject
    Fields
    • statusstring
    • createdAtFromstring
    • createdAtTostring
  • filterOpobject
    Fields
    • statusstring

      one of eq, in

    • createdAtFromstring

      one of gte

    • createdAtTostring

      one of lte

Responses

200
  • dataobjectrequired
    Fields
    • dataarray<object>required
      Item fields
      • idstring (uuid)required
      • statusstringrequired
      • totalnumberrequired
      • currencystringrequired
      • invoiceUrlstring | nullrequired
      • paidAtstring | nullrequired
      • createdAtstringrequired
    • metadataobjectrequired
      Fields
      • pageintegerrequired
      • limitintegerrequired
      • totalintegerrequired
      • totalPagesintegerrequired
      • hasNextbooleanrequired
      • hasPrevbooleanrequired
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/billing/invoices" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/billing/subscription/cancel

Bearer token

Cancel the org subscription. Trials cancel immediately; paid subscriptions cancel at period end.

Path parameters

  • orgIdstring (uuid)required

Responses

200Cancel the org subscription. Trials cancel immediately; paid subscriptions cancel at period end.
  • dataobjectrequired
    Fields
    • cancelAtPeriodEndbooleanrequired
    • messagestringrequired
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/billing/subscription/cancel" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/billing/subscription/pause

Bearer token

Pause the org subscription at period end. Not available while the subscription is trialing.

Path parameters

  • orgIdstring (uuid)required

Responses

200Pause the org subscription at period end. Not available while the subscription is trialing.
  • dataobjectrequired
    Fields
    • statusstringrequired
    • messagestringrequired
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/billing/subscription/pause" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/billing/subscription/resume

Bearer token

Path parameters

  • orgIdstring (uuid)required

Responses

200
  • dataobjectrequired
    Fields
    • statusstringrequired
    • messagestringrequired
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/billing/subscription/resume" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

POST/v1/orgs/{orgId}/billing/subscription/update-payment

Bearer token

Create a Paddle transaction (or management URL) so the customer can update their payment method.

Path parameters

  • orgIdstring (uuid)required

Request body application/json

  • checkoutUrlstring (uri)

Responses

200Create a Paddle transaction (or management URL) so the customer can update their payment method.
  • dataobjectrequired
    Fields
    • transactionIdstringrequired
    • checkoutUrlstring (uri) | null
Request
curl -X POST "https://api.adventur.ai/v1/orgs/$ORG_ID/billing/subscription/update-payment" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

GET/v1/orgs/{orgId}/billing/transactions

Bearer token

Path parameters

  • orgIdstring (uuid)required

Query parameters

  • pageinteger
  • limitinteger
  • sortBystring

    one of createdAt, amount, status, type

  • sortDirstring

    one of asc, desc

  • filterobject
    Fields
    • statusstring
    • typestring
    • createdAtFromstring
    • createdAtTostring
  • filterOpobject
    Fields
    • statusstring

      one of eq, in

    • typestring

      one of eq, in

    • createdAtFromstring

      one of gte

    • createdAtTostring

      one of lte

Responses

200
  • dataobjectrequired
    Fields
    • dataarray<object>required
      Item fields
      • idstring (uuid)required
      • typestringrequired
      • amountnumberrequired
      • currencystringrequired
      • statusstringrequired
      • invoiceUrlstring | nullrequired
      • paidAtstring | nullrequired
      • createdAtstringrequired
    • metadataobjectrequired
      Fields
      • pageintegerrequired
      • limitintegerrequired
      • totalintegerrequired
      • totalPagesintegerrequired
      • hasNextbooleanrequired
      • hasPrevbooleanrequired
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/billing/transactions" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"

GET/v1/orgs/{orgId}/billing/transactions/{transactionId}/invoice

Bearer token

Path parameters

  • orgIdstring (uuid)required
  • transactionIdstring (uuid)required

Responses

200
  • dataobjectrequired
    Fields
    • urlstring (uri)required
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/billing/transactions/$TRANSACTION_ID/invoice" \
  -H "Authorization: Bearer $ADVENTURAI_TOKEN"