Paid plans API is one of 22 APIs that Paid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Plans. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
15 operations
across 12 paths,
and defines 118 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.
The identity and technical contract details declared by the specification.
ProductPricingInputDiscriminatorMappingSeatBasedGraduatedBillingType
string
ProductPricingInputDiscriminatorMappingUsageVolumeSignalType
string
ProductPricingInputDiscriminatorMappingSeatBasedVolumeBillingFrequency
string
Agent
object
8 properties
4 required
Customer
object
13 properties
3 required
ProductPricingInputDiscriminatorMappingUsageBracketedPrepaidCreditsBillingFrequency
string
ProductPricingInputDiscriminatorMappingUsageVolumeBillingType
string
UsageSummaryOrder
object
Associated order information
2 properties
PlanWithFeatures
object
A plan with its features (product-attribute pairs) for display
10 properties
7 required
ProductPricingInputDiscriminatorMappingUsageCostPlusBillingType
string
plans_getCurrent_Response_200
object
2 properties
2 required
ProductPricingInputDiscriminatorMappingUsagePerUnitSignalType
string
Plan_2
object
12 properties
12 required
PlanCreditBenefitRecipient
string
ProductType
string
The type of product
PlanListResponse
object
2 properties
2 required
OrderLineAttributePricing
object
5 properties
PlanPricing
object
The pricing configuration for a plan. Uses the same PricePoints structure as product pricing.
3 properties
2 required
Pagination
object
4 properties
4 required
PlansCurrentGetResponsesContentApplicationJsonSchemaPlanFeaturesItems
object
4 properties
4 required
ProductPricingInputDiscriminatorMappingRecurringVolumeBillingType
string
ProductPricingInputDiscriminatorMappingUsagePrepaidCreditsSignalType
string
ProductCreditBenefitInput
object
10 properties
2 required
CancelRenewalResponse
object
Response after successfully cancelling an order's renewal
5 properties
5 required
ErrorResponse
object
3 properties
1 required
ProrationDetail
object
Details about the proration calculation for an attribute
8 properties
PlanCreditBenefit
object
10 properties
2 required
PlanWithFeaturesType
string
The type of plan (flat for fixed pricing, usage for usage-based, credit for prepaid credits)
ProductPricingInputDiscriminatorMappingUsagePerUnitBillingType
string
Order
object
16 properties
PlansCurrentGetResponsesContentApplicationJsonSchemaPlan
object
The plan details, or null if the customer has no active plan
9 properties
6 required
PlanGroup
object
A plan group containing multiple plans
7 properties
5 required
ProductPricingInputDiscriminatorMappingUsageBracketedPrepaidCreditsCreditUnitBracketsItems
object
2 properties
2 required
AgentPricePoint
object
4 properties
PlanPricing_2
object
Pricing configuration for a plan attribute. Money amounts are expressed in cents.
4 properties
4 required
ProductPricingInputDiscriminatorMappingUsageGraduatedSignalType
string
UsageSummary
object
A single usage summary record
17 properties
13 required
ProductSimplePricePointTiersItemsTierBillingType
string
PlanAttributeInput
object
3 properties
2 required
ProductPricingInputDiscriminatorMappingRecurringGraduatedBillingType
string
PlansCurrentGetResponsesContentApplicationJsonSchemaSubscription
object
The subscription details, or null if the customer has no active plan
5 properties
4 required
ProductPricingInputDiscriminatorMappingSeatBasedPerUnitBillingType
string
ProductTieredPricePointTiersItems
object
7 properties
1 required
PlanPlanProductsItems
object
8 properties
ProductPricingInputDiscriminatorMappingUsageGraduatedBillingType
string
ProductPricingInputDiscriminatorMappingUsagePerUnitBillingFrequency
string
ProductPricingInputDiscriminatorMappingUsageVolumeBillingFrequency
string
ProductPricingInputDiscriminatorMappingSeatBasedVolumeBillingType
string
ProductPricingInputDiscriminatorMappingRecurringPerUnitBillingFrequency
string
Error
object
An error response from the Paid API
1 property
1 required
PlanCreditBenefitCreditGrantTiming
string
ProductTieredPricePoint
object
6 properties
3 required
ProductPricingInputDiscriminatorMappingRecurringGraduatedBillingFrequency
string
ProductPricingInputDiscriminatorMappingUsagePrepaidCreditsBillingFrequency
string
PlanAttribute
object
5 properties
5 required
ProductCreditBenefitInputAllocationCadence
string
ProductPricingInputDiscriminatorMappingSeatBasedPerUnitBillingFrequency
string
ProductSimplePricePointTiersItems
object
7 properties
1 required
AgentAttribute
object
3 properties
3 required
ApiError
object
An API error response from the Paid API
3 properties
ProductPricingInputDiscriminatorMappingUsageGraduatedBillingFrequency
string
PlanUpgradePathGroup
object
2 properties
2 required
ProductPricingInputDiscriminatorMappingOneTimePerUnitFeeType
string
ProductTieredPricePointTiersItemsTierBillingType
string
PlanPricingPricingType
string
ProductPricingInputDiscriminatorMappingRecurringPercentOfTotalBillingFrequency
string
CreatePlanRequest
object
6 properties
2 required
UpdatePlanUpgradePathRequest
object
2 properties
2 required
ProductPricingInputDiscriminatorMappingOneTimePerUnitBillingType
string
ProductPricingInputDiscriminatorMappingUsagePrepaidCreditsBillingType
string
ProductPricingInputDiscriminatorMappingRecurringPerUnitBillingType
string
ProductPricingInputDiscriminatorMappingSeatBasedPrepaidCreditsBillingFrequency
string
ProrationUpgradeResponse
object
Response after successfully scheduling a plan change
8 properties
8 required
ProductPricingInputDiscriminatorMappingUsageCostPlusSignalType
string
PricePoint
object
4 properties
UpdatePlanRequest
object
6 properties
PlanUpgradePathResponse
object
1 property
1 required
PlansCurrentGetResponsesContentApplicationJsonSchemaPlanType
string
The type of plan
OrderLineAttribute
object
4 properties
ProductPricingInputDiscriminatorMappingUsageBracketedPrepaidCreditsPricingInput
object
1 property
1 required
ProductPricingInputDiscriminatorMappingSeatBasedGraduatedBillingFrequency
string
ProductSimplePricePoint
object
6 properties
2 required
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
PlanType
string
The type of plan (flat for fixed pricing, usage for usage-based, credit for prepaid credits)
ProductCreditBenefitInputCreditGrantTiming
string
UpdatePlanRequestStatus
string
Set to archived to archive this plan, or active to restore it.
Address
object
6 properties
5 required
Pricing
object
7 properties
5 required
UsageSummaryOrderLine
object
Associated order line information
2 properties
ProductPricingInputDiscriminatorMappingUsageCostPlusBillingFrequency
string
PlanPricingBillingFrequency
string
The billing frequency for the plan
ProductPricingInputDiscriminatorMappingUsageBracketedPrepaidCreditsSignalType
string
OrderLine
object
14 properties
Plan
object
A plan containing products and their attributes
12 properties
8 required
PlanPlanProductsItemsPlanProductAttributeItems
object
7 properties
PlanCreditBenefitAllocationCadence
string
ProductPricingInputDiscriminatorMappingSeatBasedPrepaidCreditsBillingType
string
Product
object
A product in the Paid system (previously called Agent)
13 properties
5 required
UsagePaginationMeta
object
Pagination metadata for usage summaries
4 properties
4 required
PlansCurrentGetResponsesContentApplicationJsonSchemaPlanFeaturesItemsUsage
object
Current usage and limits for this feature
4 properties
4 required
PlanWithFeaturesFeaturesItems
object
3 properties
3 required
ProductCreditBenefitInputRecipient
string
ProductPricingInputDiscriminatorMappingRecurringVolumeBillingFrequency
string
PlanCreditBenefitRolloverDurationUnit
string
ProductPricingInputDiscriminatorMappingUsageBracketedPrepaidCreditsBillingType
string
AgentPricePointTiers
object
3 properties
1 required
ProductPricingInputDiscriminatorMappingRecurringPercentOfTotalBillingType
string
ProductPricingInputDiscriminatorMappingUsageBracketedPrepaidCreditsPricingInputKind
string
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Paid publishes across the network.
