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

Paigo Customers API

Manage customers in Paigo.

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.2.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.2.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
Get all customers
GetAllCustomers → 200400
POST
/customers
Create a customer
CreateACustomer body → 201400
POST
/customers/{customerId}/children/{childId}
Assign a child to a customer
AssignAChildToACustomer body → 201400
DELETE
/customers/{customerId}/children/{childId}
Remove a child from a customer
RemoveAChildFromACustomer → 200400
PUT
/customers/{customerId}/children/{childId}
Update a child to a customer
UpdateAChildToACustomer body → 200400
GET
/customers/{customerId}
Get a customer by ID
GetACustomerByID 1 param → 200400404
PUT
/customers/{customerId}
Update a customer
UpdateACustomer 1 param body → 200400404
DELETE
/customers/{customerId}
Delete a customer
DeleteACustomer 1 param → 200404
POST
/customers/{customerId}/refunds
Create a refund for customer
CreateARefundForCustomer body → 201400
GET
/customers/{customerId}/refunds
Get a refund for customer
GetARefundForCustomer → 200400
GET
/customers/{customerId}/enrollment
Get a customer enrollment
GetACustomerEnrollment 1 param → 200400404
PUT
/customers/{customerId}/enrollment
Update customer offering enrollment
UpdateCustomerOfferingEnrollment 1 param body → 200400404
GET
/customers/{customerId}/payments
Get payments for customer
GetPaymentsForCustomer 1 param → 200400
GET
/customers/{customerId}/stripePortal
Get stripe portal for customer
GetStripePortalForCustomer → 200400
PUT
/customers/{customerId}/freeTrial
Update free trial
UpdateFreeTrial 1 param body → 200400404
GET
/customers/{customerId}/usage
Get usage data for a customer
GetUsageDataForACustomer 6 params → 200400404
GET
/customers/{customerId}/token
Get a customer auth token
GetACustomerAuthToken 1 param → 200404
POST
/customers/{customerId}/transactions
Create a wallet transaction
CreateAWalletTransaction 1 param body → 201
GET
/customers/{customerId}/transactions
Get customer credit ledger
GetCustomerCreditLedger 1 param → 200400404

Schemas 55

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

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

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
Paigo Invoices API
Paigo Measurements API
Paigo Offerings API
Paigo Settings API
Paigo Usage API
Paigo Webhooks API
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.