How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Paid

Paid customers API

The customers API from Paid — 22 operation(s) for customers.

Documentation Provider Profile APIs.io OpenAPI GitHub

Paid customers API is one of 22 APIs that Paid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 33 operations across 22 paths, and defines 79 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.agentpaid.io/api/v1.

33 operations 22 paths 79 schemas 6 DELETE16 GET7 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.agentpaid.io/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Paid customers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth).

Paths & Operations 33

Across 22 paths, the API surfaces 33 operations — 6 DELETE, 16 GET, 7 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

customers 33
GET
/customers
List customers
list 1 param → 200
POST
/customers
Create a new customer
create 1 param body → 200
GET
/customers/{customerId}
Get customer by ID
get 2 params → 200
PUT
/customers/{customerId}
Update customer
update 2 params body → 200
DELETE
/customers/{customerId}
Delete customer
delete 2 params → 204
GET
/customers/{customerId}/entitlement
Check customer entitlement for an event
check-entitlement 4 params → 200400404
GET
/customers/{customerId}/credit-bundles
Get customer entitlements
get-entitlements 2 params → 200403
GET
/customers/external/{externalId}
Get customer by external ID
get-by-external-id 2 params → 200
PUT
/customers/external/{externalId}
Update customer by external ID
update-by-external-id 2 params body → 200
DELETE
/customers/external/{externalId}
Delete customer by external ID
delete-by-external-id 2 params → 204
GET
/customers/external/{externalId}/costs
Fetch cost traces for a customer by external ID
get-costs-by-external-id 6 params → 200400403404
GET
/customers/external/{externalId}/usage
Fetch usage summaries for a customer by external ID
get-usage-by-external-id 6 params → 200400403404
GET
/customers/external/{externalId}/payment-methods
List customer payment methods by external ID
list-payment-methods 2 params → 200403404
POST
/customers/external/{externalId}/payment-methods
Create customer payment method by external ID
create-payment-method 2 params body → 200400403404
DELETE
/customers/external/{externalId}/payment-methods/{paymentMethodId}
Delete customer payment method by external ID
delete-payment-method 3 params → 204403404
GET
/customers/
List customers
list-customers 9 params → 200400403500
POST
/customers/
Create a new customer
create-customer 1 param body → 201400403500
GET
/customers/{id}/aliases
List customer aliases
list-customer-aliases 4 params → 200400403404500
POST
/customers/{id}/aliases
Create customer alias
create-customer-alias 2 params body → 201400403404409500
DELETE
/customers/{id}/aliases/{alias}
Delete customer alias
delete-customer-alias 3 params → 200403404500
GET
/customers/{id}
Get customer
get-customer-by-id 2 params → 200403404500
PUT
/customers/{id}
Update customer
update-customer-by-id 2 params body → 200400403404500
DELETE
/customers/{id}
Delete customer
delete-customer-by-id 2 params → 200400403404500
GET
/customers/{id}/state
Get customer state
get-customer-state-by-id 2 params → 200403404500
GET
/customers/external/{externalId}/aliases
List customer aliases by external ID
list-customer-aliases-by-external-id 4 params → 200400403404500
POST
/customers/external/{externalId}/aliases
Create customer alias by external ID
create-customer-alias-by-external-id 2 params body → 201400403404409500
DELETE
/customers/external/{externalId}/aliases/{alias}
Delete customer alias by external ID
delete-customer-alias-by-external-id 3 params → 200403404500
GET
/customers/external/{externalId}/state
Get customer state by external ID
get-customer-state-by-external-id 2 params → 200403404500
GET
/customers/{id}/credits/balances
Get customer credit balances
get-customer-credit-balances 2 params → 200403404500
POST
/customers/{id}/credits/grants
Grant customer credits
grant-customer-credits 2 params body → 201400403404500
GET
/customers/external/{externalId}/credits/balances
Get customer credit balances by external ID
get-customer-credit-balances-by-external-id 2 params → 200403404500
POST
/customers/external/{externalId}/credits/grants
Grant customer credits by external ID
grant-customer-credits-by-external-id 2 params body → 201400403404500
PUT
/customers/{customerExternalId}/users/{userExternalId}
Upsert customer user by external IDs
upsert-customer-user-by-external-id 3 params body → 200400403404500

Schemas 79

The contract defines 79 schemas that model the data the API accepts and returns. The most detailed are UsageSummary (17 properties), Customer_2 (17 properties), Customer (13 properties), ContactCreateForCustomer (12 properties). Each schema is shown below with its type and property counts.

Customer
object
13 properties 3 required
UsageSummaryOrder
object
Associated order information
2 properties
StripeConnection
object
Stripe customer link, or null when no Stripe gateway account is configured.
1 property 1 required
CustomerCreateMetadata
object
Flexible JSON field for storing custom metadata about the customer
EmptyResponse
object
PaginationMeta
object
Pagination metadata for cost traces
10 properties 4 required
CreditGrantResult
object
4 properties 4 required
CustomerCreate
object
11 properties 1 required
Pagination
object
4 properties 4 required
Salutation
string
CustomerStatus
string
Customer status: churned when the customer is marked as churned, active otherwise.
CustomerStateSeatStatus
string
CustomerState
object
7 properties 7 required
ErrorResponse
object
3 properties 1 required
CustomerStateSeats
object
4 properties 4 required
CustomerStateCheckoutLink
object
7 properties 7 required
CreateCustomerRequest
object
11 properties 1 required
CustomerBillingAddressResponse
object
Customer billing address, or null when no address is set.
6 properties
CustomerStateSeat
object
6 properties 6 required
CustomerStateCreditSummary
object
1 property 1 required
CostTrace
object
A single cost trace record
7 properties 6 required
UsageSummary
object
A single usage summary record
17 properties 13 required
CustomerUserStatus
string
PaymentMethodType
string
The type of payment method
CustomerUpdate
object
10 properties
UpdateCustomerRequest
object
11 properties
CreditGrantCustomer
object
2 properties 2 required
Error
object
An error response from the Paid API
1 property 1 required
CustomersGetParametersCreationState
string
CreditBalance
object
11 properties 11 required
CustomerBillingAddressInput
object
6 properties
CustomerCreationState
string
UpsertCustomerUserRequest
object
4 properties
CreditGrantCreateRequest
object
4 properties 2 required
CustomerAliasListResponse
object
2 properties 2 required
GrantCustomerCreditsResponse
object
5 properties 5 required
CreditGrant
object
9 properties 9 required
CostAmount
object
Cost amount with currency
2 properties 2 required
ContactCreateForCustomer
object
12 properties 4 required
CustomerStateCheckoutLinkStatus
string
CustomerUser
object
10 properties 10 required
customers_deletePaymentMethod_Response_204
object
Empty response body
customers_checkEntitlement_Response_200
object
1 property 1 required
CreationState
string
CustomersGetParametersStatus
string
ApiError
object
An API error response from the Paid API
3 properties
CurrencyCode
string
ISO 4217 currency code, for example USD, EUR, or GBP.
CustomerConnections
object
Linked external system IDs for this customer.
1 property 1 required
CustomerUpdateMetadata
object
Flexible JSON field for storing custom metadata about the customer
customers_delete_Response_204
object
Empty response body
CustomerStateOrder
object
8 properties 8 required
CreditBalanceListResponse
object
1 property 1 required
CustomersCustomerIdEntitlementGetParametersView
string
PaymentMethodCard
object
Card details (present when type is 'card')
4 properties
PaymentMethod
object
A customer's payment method
6 properties
CreditGrantCurrency
object
2 properties 2 required
CreditBalanceRecipient
string
UsageSummariesResponse
object
Response containing usage summaries and pagination metadata
2 properties 2 required
CustomerMetadata
object
Flexible JSON field for storing custom metadata about the customer
EntitlementUsage
object
Tracks the usage of an entitlement for a customer
12 properties 9 required
Address
object
6 properties 5 required
PaymentMethodUsBankAccount
object
US bank account details (present when type is 'usbankaccount')
3 properties
PaymentMethodUsBankAccountAccountType
string
UsageSummaryOrderLine
object
Associated order line information
2 properties
CustomerStateSeatAssignee
object
4 properties 4 required
CustomerStateCreditBalance
object
4 properties 4 required
CustomerListResponse
object
2 properties 2 required
CostTracesResponse
object
Response containing cost traces and pagination metadata
2 properties 2 required
CustomerAliasCreateRequest
object
3 properties 1 required
UsagePaginationMeta
object
Pagination metadata for usage summaries
4 properties 4 required
TaxExemptStatus
string
CustomerStateProductRef
object
3 properties 3 required
CreationSource
string
CreditGrantResultStatus
string
Credit grants are active immediately when created.
customers_deleteByExternalId_Response_204
object
Empty response body
Customer_2
object
17 properties 17 required
CustomerStateCustomer
object
4 properties 4 required
CustomerStateOrderState
string
CustomerAlias
object
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paid-customers-api-openapi.yml Raw ↑

Other APIs Paid publishes across the network.

Paid agents API
AE Profile APIs.io
Paid analyticsExperimental API
AE Profile APIs.io
Paid checkouts API
AE Profile APIs.io
Paid contacts API
AE Profile APIs.io
Paid costs API
AE Profile APIs.io
Paid credits API
AE Profile APIs.io
Paid customer-groups API
AE Profile APIs.io
Paid customer-portals API
AE Profile APIs.io
Paid customViewsExperimental API
AE Profile APIs.io
Paid invoices API
AE Profile APIs.io
Paid orders API
AE Profile APIs.io
Paid orders > lines API
AE Profile APIs.io
#Customers
← Back to P APIs
API Details
ID
paid:paid-customers-api
Base URL
https://api.agentpaid.io/api/v2
Docs
https://docs.paid.ai/api-reference/api-reference
Provider
Paid
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=paid-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/paid-customers-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Paid customers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.