# BillDog API

**Canonical:** https://apis.io/apis/billdog-io/billdog-io-api/  
**Provider:** BillDog — https://apis.io/providers/billdog-io/  
**Base URL:** https://api.billdog.io  
**Documentation:** https://billdog.io/docs/auth/api-reference

BillDog API is published by [BillDog](https://apis.io/providers/billdog-io/) on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

BillDog API as documented publicly: 41 operations. Contract generated from the documentation by API Evangelist (2026-11-02); not the provider's own document.

## Operations (41)

| Method | Path | Summary |
|---|---|---|
| POST | `/auth-account` | The signed-in user's own account view |
| POST | `/auth-attempt` | Submit a factor. identifier is required for a first factor and optional for totp / backup_code , where mfa_token names the account |
| POST | `/auth-config` | What this project requires before a sign-up is accepted |
| POST | `/auth-impersonate` | Act as a user, for support |
| POST | `/auth-import` | Import users from Clerk, Auth0 or Firebase |
| POST | `/auth-introspect` | Is this token live right now? |
| GET | `/auth-jwks` | Public keys for offline verification |
| POST | `/auth-oauth-bounce` | Where a provider returns to — Apple's form POST, and every native flow — before being forwarded to where the flow began. Registered with the provider once; n... |
| POST | `/auth-oauth-callback` | Complete a redirect sign-in. Answers mfa_required + mfa_token with no session for an MFA-enrolled account, exactly like auth-attempt |
| POST | `/auth-oauth-start` | Begin a redirect sign-in (PKCE) |
| POST | `/auth-oauth-verify` | Exchange a provider ID token for a session |
| POST | `/auth-org` | Organizations, members, invitations and domains |
| POST | `/auth-passkey` | WebAuthn registration and sign-in |
| POST | `/auth-prepare` | Send a one-time code |
| POST | `/auth-provision-keys` | Provision or rotate signing keys |
| POST | `/auth-revoke` | Sign out |
| POST | `/auth-sessions` | List a user's sessions |
| POST | `/auth-set-password` | Set a password — by reset code, or as a signed-in change |
| POST | `/auth-sign-up` | Begin a sign-up |
| POST | `/auth-sso-acs/{connectionId}` | SAML assertion consumer service |
| GET | `/auth-sso-acs/{connectionId}/metadata` | SP metadata for the IdP |
| POST | `/auth-sso-callback` | Complete an OIDC enterprise sign-in |
| POST | `/auth-sso-start` | Route a work email to its enterprise connection |
| POST | `/auth-token` | Refresh a session |
| POST | `/auth-user-factors` | Manage second factors |
| POST | `/functions/v1/create-web-checkout` | Create Checkout Session (API) |
| POST | `/functions/v1/redeem-purchase` | Redeem Purchase |
| GET | `/health-check` | API reachability check |
| POST | `/manage-auth-settings` | Project auth settings, SSO connections, SCIM tokens and signing keys |
| POST | `/manage-jwt-templates` | JWT templates, programmatically |
| GET | `/scim-v2/Groups` | List directory groups |
| GET | `/scim-v2/ServiceProviderConfig` | Advertised SCIM capabilities |
| GET | `/scim-v2/Users` | List or filter provisioned users |
| POST | `/scim-v2/Users` | Provision a user |
| DELETE | `/scim-v2/Users/{id}` | Deprovision a user |
| PATCH | `/scim-v2/Users/{id}` | Update or deactivate a user |
| POST | `/v1/create-stripe-portal-session` | Your server calls POST /v1/create-stripe-portal-session with the secret key to create a billing portal session. |
| POST | `/v1/ingest-events` | POST /v1/ingest-events |
| POST | `/v1/record-external-purchase` | Record them from your server with your secret key ( POST /v1/record-external-purchase ). |
| POST | `/v1/virtual-currency/transactions` | POST /v1/virtual-currency/transactions |
| POST | `/validate-api-key` | Validates your API key |

## Machine-readable artifacts (8)

- **OpenAPI** — https://artifacts.apis.io/billdog-io/openapi/_ae-authored/billdog-io-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/billdog-io/json-schema/billdog-io-post-functions-v1-create-web-checkout-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/billdog-io/json-schema/billdog-io-post-functions-v1-redeem-purchase-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/billdog-io/json-schema/billdog-io-post-functions-v1-create-web-checkout-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/billdog-io/json-schema/billdog-io-post-v1-ingest-events-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/billdog-io/json-schema/billdog-io-post-v1-virtual-currency-transactions-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/billdog-io/json-schema/billdog-io-post-functions-v1-redeem-purchase-request-schema.json
- **APIsJSON** — https://artifacts.apis.io/billdog-io/apis.yml

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/billdog-io/billdog-io-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/billdog-io/.
