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
Paigo

Paigo Customers API

Manage customers in Paigo.

Documentation Provider Profile APIs.io OpenAPI GitHub

Paigo Customers API is one of 8 APIs that Paigo 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, API documentation, and a getting-started guide.

This API exposes 19 operations across 11 paths, and defines 55 schemas. It is described by OpenAPI 3.0.0, at version v1.10.

Requests are made against a single base URL, https://api.prod.paigo.tech.

19 operations 11 paths 55 schemas 2 DELETE9 GET4 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
v1.10
Base URL
https://api.prod.paigo.tech
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Paigo Customers API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (bearer) using the clientCredentials flow.

  • bearer — Use bearer token to authenticate Bearer

Paths & Operations 19

Across 11 paths, the API surfaces 19 operations — 2 DELETE, 9 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Customers 19

Manage customers in Paigo.

GET
/customers
List all customers created in this account
Get all Customers → 200400
POST
/customers
Create a customer
Create a customer body → 201400
POST
/customers/{customerId}/children/{childId}
Assign a child to a customer
Assign a child to a customer body → 201400
DELETE
/customers/{customerId}/children/{childId}
Remove a child from parent
Remove a child from a customer → 200400
PUT
/customers/{customerId}/children/{childId}
Update child relationship
Update a child to a customer body → 200400
GET
/customers/{customerId}
Find one customer
Get a customer by ID 1 param → 200400404
PUT
/customers/{customerId}
Update a customer
Update a customer 1 param body → 200400404
DELETE
/customers/{customerId}
Delete a customer
Delete a customer 1 param → 200404
POST
/customers/{customerId}/refunds
Create Customer Refund NOTE: This endpoint currently only supports Stripe for a refund channel. Customers with manual payments will cause an 400 error response.
Create a refund for customer body → 201400
GET
/customers/{customerId}/refunds
Get customer refunds NOTE: This endpoint currently only supports Stripe for a refund channel. Customers with manual payments will cause an 400 error response.
Get a refund for customer → 200400
GET
/customers/{customerId}/enrollment
Get a Customer Enrollment
Get a Customer Enrollment 1 param → 200400404
PUT
/customers/{customerId}/enrollment
Update Customer Enrollment
Update Customer Offering Enrollment 1 param body → 200400404
GET
/customers/{customerId}/payments
Get customer payments NOTE: This endpoint currently only supports Stripe for a payment channel. Customers with manual payments will cause an 400 error response.
Get payments for customer 1 param → 200400
GET
/customers/{customerId}/stripePortal
Get Stripe Portal for customer → 200400
PUT
/customers/{customerId}/freeTrial
Update a free trial of a customer
Update free trial 1 param body → 200400404
GET
/customers/{customerId}/usage
Get usage data for a customer
Get usage data for a customer 6 params → 200400404
GET
/customers/{customerId}/token
Get a token to allow SaaS customers to view their billing data in paigo securely
Get a customer auth token 1 param → 200404
POST
/customers/{customerId}/transactions
Commit a transaction to the ledger for a customer. This will update thier credit balances
Create a wallet transaction 1 param body → 201
GET
/customers/{customerId}/transactions
Get the ledger of wallet transactions applied to a customer
Get customer credit ledger 1 param → 200400404

Schemas 55

The contract defines 55 schemas that model the data the API accepts and returns. The most detailed are ReadAllCustomersResponseData (22 properties), ReadCustomerResponseData (22 properties), ReadDimensionResponseData (16 properties), ReadOfferingResponseData (15 properties). Each schema is shown below with its type and property counts.

CountBasedConsumptionUnit
object
2 properties 2 required
Address
object
6 properties 5 required
AggregatedUsageResponse
object
3 properties 2 required
TimeBasedConsumptionUnit
object
2 properties 2 required
UpdateFreeTrialDto
object
3 properties 1 required
CreateCreditDto
object
3 properties 1 required
ReadAllCustomerResponseDTO
object
2 properties 2 required
StripePaymentChannelOptions
object
1 property
CreateCustomerResponseDto
object
3 properties 2 required
DatastoreAccessInformationResponse
object
8 properties 3 required
ReadOfferingResponseData
object
15 properties 3 required
CreateCustomerDto
object
13 properties 3 required
GetCustomerStripePortalResponse
object
2 properties 1 required
ReadCustomerUsageData
object
2 properties 2 required
UsageForCustomerEnrollment
object
3 properties 2 required
FindCustomerPaymentsResponse
object
2 properties 2 required
DimensionTierDto
object
4 properties 2 required
BasicResponseDTO
object
1 property 1 required
ReadCustomerResponseDTO
object
2 properties 2 required
ReadTransactionLedger
object
3 properties 3 required
DatabasedConsumptionUnit
object
2 properties 2 required
UnAggregatedUsageResponse
object
3 properties 2 required
ReadChildRowResponseData
object
3 properties 3 required
CreateChildRowDto
object
1 property
StripeRefundChannelOptions
object
1 property
CustomerEnrollmentResponseDto
object
2 properties 2 required
BasicUsageDocument
object
3 properties 3 required
CreateCustomerRefundResponse
object
1 property 1 required
AgentAccessInformation
object
3 properties 2 required
CreditLedgerResponse
object
2 properties 2 required
CustomerEnrollmentResponseData
object
3 properties 2 required
CustomerContractDiscount
object
3 properties 2 required
DimensionOverridesDto
object
4 properties 1 required
NotFoundException
object
DeleteCustomerResponseDto
object
2 properties 2 required
InvoiceLineItem
object
4 properties 3 required
ReadAllCustomersResponseData
object
22 properties 4 required
FindCustomerRefundsResponse
object
2 properties 2 required
StripeRefundResponseDto
object
7 properties 6 required
InfrastructureAccessInformation
object
5 properties 4 required
ReadDimensionResponseData
object
16 properties 5 required
CustomOverrides
object
3 properties
UpdateFreeTrialResponseDto
object
2 properties 2 required
UpdateCustomerDto
object
14 properties
CreateCustomerRefundDto
object
4 properties 1 required
ReadCustomerResponseData
object
22 properties 4 required
CustomerInvoiceMetadata
object
14 properties 9 required
KafkaDeploymentParametersDto
object
6 properties 6 required
UpdateCustomerEnrollmentDto
object
5 properties
ReadPaymentDto
object
4 properties 4 required
ReadMeasurementResponseData
object
4 properties 3 required
InvoiceCommunicationHistory
object
3 properties
UsageResponseDocument
object
4 properties
DimensionTiersGroupByMetadataDto
object
2 properties 2 required
CustomerAuthenticationTokenResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paigo-customers-api-openapi.yml Raw ↑

Other APIs Paigo publishes across the network.

Paigo Dimensions API
AE Profile APIs.io
Paigo Invoices API
AE Profile APIs.io
Paigo Measurements API
AE Profile APIs.io
Paigo Offerings API
AE Profile APIs.io
Paigo Settings API
AE Profile APIs.io
Paigo Usage API
AE Profile APIs.io
Paigo Webhooks API
AE Profile APIs.io
#Customers
← Back to P APIs
API Details
ID
paigo:paigo-customers-api
Base URL
https://api.prod.paigo.tech
Docs
https://docs.paigo.tech/
Provider
Paigo
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=paigo-customers-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/paigo-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 Paigo 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.