New to Corsair? See API access, authentication, and error handling.
Balance Lines
create
balanceLines.create
Add a balance line, such as a one-off charge or credit in cents, to a customerβs next invoice
Risk: destructive
await corsair.proabono.api.balanceLines.create({ ReferenceCustomer: 'cust-42', Label: 'One-off setup', Amount: 59900 });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | Yes | Your own identifier for the resource, unique within its kind. |
IdSubscription | number | No | The ProAbono numeric id. |
Label | string | No | The line label, shown on the invoice. |
Amount | number | Yes | In cents, before taxes. A negative value is a credit. |
Quantity | number | No | Shown on the invoice only; it does not change the amount. |
EnsureBillable | boolean | No | True by default on ProAbono: a customer without valid payment information answers 403. False adds the line anyway. |
| Name | Type | Required | Description |
|---|---|---|---|
IdSegment | number | null | No | The ProAbono numeric id. |
IdCustomer | number | null | No | The ProAbono numeric id. |
IdSubscription | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
ReferenceCustomer | string | null | No | β |
LabelLocalized | string | null | No | β |
PricingLocalized | string | null | No | HTML. |
Currency | string | null | No | β |
AmountSubtotal | number | null | No | In cents, before taxes. |
AmountTotal | number | null | No | In cents, with taxes. |
DateMove | string | null | No | When the line is billed, for a line outside a period. |
QuantityReported | number | null | No | β |
QuantityBilled | number | null | No | β |
DatePeriodStart | string | null | No | β |
DatePeriodTerm | string | null | No | β |
list
balanceLines.list
List balance lines by customer, segment, feature or subscription, with their totals
Risk: read
await corsair.proabono.api.balanceLines.list({ ReferenceCustomer: 'cust-42' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | No | Your own identifier for the resource, unique within its kind. |
ReferenceSegment | string | No | Your own identifier for the resource, unique within its kind. |
ReferenceFeature | string | No | Your own identifier for the resource, unique within its kind. |
IdSubscription | number | No | The ProAbono numeric id. |
Page | number | No | β |
SizePage | number | No | Rows per page. 0 returns only the totals in Computations. |
| Name | Type | Required | Description |
|---|---|---|---|
balanceLines | object[] | Yes | β |
Page | number | null | No | The page this answer holds, from 1. |
SizePage | number | null | No | Rows per page. |
Count | number | null | No | Rows on this page. |
TotalItems | number | null | No | Rows in the whole collection, across pages. |
Computations | object | null | No | Totals in cents over every matching line. |
balanceLines full type
balanceLines full type
{
IdSegment?: number | null,
IdCustomer?: number | null,
IdSubscription?: number | null,
ReferenceSegment?: string | null,
ReferenceCustomer?: string | null,
LabelLocalized?: string | null,
PricingLocalized?: string | null,
Currency?: string | null,
AmountSubtotal?: number | null,
AmountTotal?: number | null,
DateMove?: string | null,
QuantityReported?: number | null,
QuantityBilled?: number | null,
DatePeriodStart?: string | null,
DatePeriodTerm?: string | null
}[]
Computations full type
Computations full type
{
AmountSubtotal?: number | null,
AmountTotal?: number | null
} | null
Customers
anonymize
customers.anonymize
Erase a customerβs personal data. This cannot be undone, and ProAbono keeps the billing record only as it must
Risk: destructive Β· Irreversible
await corsair.proabono.api.customers.anonymize({ ReferenceCustomer: 'cust-42' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | Yes | Your own identifier for the resource, unique within its kind. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
ReferenceCustomer | string | null | No | β |
IsActive | boolean | null | No | β |
create
customers.create
Create a customer with your own reference, which subscriptions and usages then identify it by
Risk: write
await corsair.proabono.api.customers.create({ ReferenceCustomer: 'cust-42', Name: 'Jane Smith', Email: 'jane@example.com' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | Yes | Your own identifier for the resource, unique within its kind. |
Name | string | No | Full name of the customer. |
Email | string | No | β |
Language | string | No | β |
ReferenceSegment | string | No | Your own identifier for the resource, unique within its kind. |
ReferenceOffer | string | No | An offer the customer wants; the answer then carries a subscribe link. |
ReferenceAffiliation | string | No | The affiliate who brought the customer. |
Metadata | Record<string, JsonValue> | No | Your own key-value data, stored on the resource. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
ReferenceCustomer | string | null | No | β |
IdSegment | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
Name | string | null | No | β |
FirstName | string | null | No | β |
LastName | string | null | No | β |
Email | string | null | No | β |
Company | string | null | No | β |
Country | string | null | No | β |
Language | string | null | No | β |
Currency | string | null | No | β |
IsBillable | boolean | null | No | False until the customer has valid payment information. |
IsActive | boolean | null | No | β |
Status | string | null | No | The customer status, such as Enabled. |
ReferenceAffiliation | string | null | No | β |
DateAffiliation | string | null | No | β |
DateCreated | string | null | No | β |
Metadata | JsonValue | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
get
customers.get
Read one customer by your reference, with whether it is billable
Risk: read
await corsair.proabono.api.customers.get({ ReferenceCustomer: 'cust-42' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | Yes | Your own identifier for the resource, unique within its kind. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
ReferenceCustomer | string | null | No | β |
IdSegment | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
Name | string | null | No | β |
FirstName | string | null | No | β |
LastName | string | null | No | β |
Email | string | null | No | β |
Company | string | null | No | β |
Country | string | null | No | β |
Language | string | null | No | β |
Currency | string | null | No | β |
IsBillable | boolean | null | No | False until the customer has valid payment information. |
IsActive | boolean | null | No | β |
Status | string | null | No | The customer status, such as Enabled. |
ReferenceAffiliation | string | null | No | β |
DateAffiliation | string | null | No | β |
DateCreated | string | null | No | β |
Metadata | JsonValue | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
invalidate
customers.invalidate
Invalidate a customer: ProAbono replaces their reference so it can be reused and revokes their portal links. Subscriptions, invoices and payment methods stay
Risk: destructive
await corsair.proabono.api.customers.invalidate({ ReferenceCustomer: 'cust-42' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | Yes | Your own identifier for the resource, unique within its kind. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
ReferenceCustomer | string | null | No | β |
IsActive | boolean | null | No | β |
list
customers.list
List the customers in a segment, one page at a time
Risk: read
await corsair.proabono.api.customers.list({ Page: 1, SizePage: 20 });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceSegment | string | No | Your own identifier for the resource, unique within its kind. |
Page | number | No | 1-based page number. |
SizePage | number | No | Rows per page. |
| Name | Type | Required | Description |
|---|---|---|---|
customers | object[] | Yes | β |
Page | number | null | No | The page this answer holds, from 1. |
SizePage | number | null | No | Rows per page. |
Count | number | null | No | Rows on this page. |
TotalItems | number | null | No | Rows in the whole collection, across pages. |
customers full type
customers full type
{
Id?: number | null,
ReferenceCustomer?: string | null,
IdSegment?: number | null,
ReferenceSegment?: string | null,
Name?: string | null,
FirstName?: string | null,
LastName?: string | null,
Email?: string | null,
Company?: string | null,
Country?: string | null,
Language?: string | null,
Currency?: string | null,
IsBillable?: boolean | null,
IsActive?: boolean | null,
Status?: string | null,
ReferenceAffiliation?: string | null,
DateAffiliation?: string | null,
DateCreated?: string | null,
Metadata?: JsonValue | null,
Links?: {
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
}[]
suspend
customers.suspend
Suspend a customer without deleting anything, so they can be reactivated
Risk: write
await corsair.proabono.api.customers.suspend({ ReferenceCustomer: 'cust-42' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | Yes | Your own identifier for the resource, unique within its kind. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
ReferenceCustomer | string | null | No | β |
IsActive | boolean | null | No | β |
update
customers.update
Change a customerβs name, email, language, affiliation or metadata. ProAbono creates and updates on the same route, so an unknown reference creates a customer
Risk: write
await corsair.proabono.api.customers.update({ ReferenceCustomer: 'cust-42', Email: 'new@example.com' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | Yes | Your own identifier for the resource, unique within its kind. |
Name | string | No | β |
Email | string | No | β |
Language | string | No | β |
ReferenceAffiliation | string | No | β |
Metadata | Record<string, JsonValue> | No | Your own key-value data, stored on the resource. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
ReferenceCustomer | string | null | No | β |
IdSegment | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
Name | string | null | No | β |
FirstName | string | null | No | β |
LastName | string | null | No | β |
Email | string | null | No | β |
Company | string | null | No | β |
Country | string | null | No | β |
Language | string | null | No | β |
Currency | string | null | No | β |
IsBillable | boolean | null | No | False until the customer has valid payment information. |
IsActive | boolean | null | No | β |
Status | string | null | No | The customer status, such as Enabled. |
ReferenceAffiliation | string | null | No | β |
DateAffiliation | string | null | No | β |
DateCreated | string | null | No | β |
Metadata | JsonValue | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
Features
get
features.get
Read one feature by its reference
Risk: read
await corsair.proabono.api.features.get({ ReferenceFeature: 'feat-users' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceFeature | string | Yes | Your own identifier for the resource, unique within its kind. |
ReferenceSegment | string | No | Your own identifier for the resource, unique within its kind. |
ReferenceCustomer | string | No | Your own identifier for the resource, unique within its kind. |
Language | string | No | β |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
ReferenceFeature | string | null | No | β |
IdSegment | number | null | No | The ProAbono numeric id. |
TitleLocalized | string | null | No | β |
DescriptionLocalized | string | null | No | β |
TypeFeature | string | null | No | Limitation, OnOff or Quantifiable. |
IsVisible | boolean | null | No | β |
CodeFeature | string | null | No | β |
list
features.list
List the features your offers carry
Risk: read
await corsair.proabono.api.features.list({});
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceSegment | string | No | Your own identifier for the resource, unique within its kind. |
ReferenceCustomer | string | No | Your own identifier for the resource, unique within its kind. |
Language | string | No | β |
IsVisible | boolean | No | β |
Page | number | No | 1-based page number. |
SizePage | number | No | Rows per page. |
| Name | Type | Required | Description |
|---|---|---|---|
features | object[] | Yes | β |
Page | number | null | No | The page this answer holds, from 1. |
SizePage | number | null | No | Rows per page. |
Count | number | null | No | Rows on this page. |
TotalItems | number | null | No | Rows in the whole collection, across pages. |
features full type
features full type
{
Id?: number | null,
ReferenceFeature?: string | null,
IdSegment?: number | null,
TitleLocalized?: string | null,
DescriptionLocalized?: string | null,
TypeFeature?: string | null,
IsVisible?: boolean | null,
CodeFeature?: string | null
}[]
Invoices
get
invoices.get
Read one invoice with its totals and links
Risk: read
await corsair.proabono.api.invoices.get({ IdInvoice: 499734 });
| Name | Type | Required | Description |
|---|---|---|---|
IdInvoice | number | Yes | The ProAbono numeric id. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
IdSegment | number | null | No | The ProAbono numeric id. |
IdCustomer | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
ReferenceCustomer | string | null | No | β |
FullNumber | string | null | No | Such as S-3.00000004. |
Status | string | null | No | Such as Due or Paid. |
StateInvoice | string | null | No | The detailed state, such as DuePending. |
DateIssue | string | null | No | β |
DatePayment | string | null | No | β |
DatePaymentLimit | string | null | No | β |
TypePayment | string | null | No | β |
AmountSubtotal | number | null | No | In cents. |
AmountTotal | number | null | No | In cents, with taxes. |
Currency | string | null | No | β |
DateUpdate | string | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
list
invoices.list
List invoices by customer or subscription, one page at a time
Risk: read
await corsair.proabono.api.invoices.list({ ReferenceCustomer: 'cust-42' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | No | Your own identifier for the resource, unique within its kind. |
IdSubscription | number | No | The ProAbono numeric id. |
Page | number | No | β |
SizePage | number | No | β |
| Name | Type | Required | Description |
|---|---|---|---|
invoices | object[] | Yes | β |
Page | number | null | No | The page this answer holds, from 1. |
SizePage | number | null | No | Rows per page. |
Count | number | null | No | Rows on this page. |
TotalItems | number | null | No | Rows in the whole collection, across pages. |
invoices full type
invoices full type
{
Id?: number | null,
IdSegment?: number | null,
IdCustomer?: number | null,
ReferenceSegment?: string | null,
ReferenceCustomer?: string | null,
FullNumber?: string | null,
Status?: string | null,
StateInvoice?: string | null,
DateIssue?: string | null,
DatePayment?: string | null,
DatePaymentLimit?: string | null,
TypePayment?: string | null,
AmountSubtotal?: number | null,
AmountTotal?: number | null,
Currency?: string | null,
DateUpdate?: string | null,
Links?: {
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
}[]
Offers
get
offers.get
Read one offer by its reference
Risk: read
await corsair.proabono.api.offers.get({ ReferenceOffer: 'premium' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceOffer | string | Yes | Your own identifier for the resource, unique within its kind. |
ReferenceSegment | string | No | Your own identifier for the resource, unique within its kind. |
ReferenceCustomer | string | No | Your own identifier for the resource, unique within its kind. |
Upgrade | boolean | No | Make the link point at the upgrade workflow. Needs ReferenceCustomer or IdSubscription. |
IdSubscription | number | No | The ProAbono numeric id. |
IgnoreFeatures | boolean | No | β |
Language | string | No | β |
Html | boolean | No | β |
Links | boolean | No | β |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
ReferenceOffer | string | null | No | β |
IdSegment | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
TitleLocalized | string | null | No | β |
DescriptionLocalized | string | null | No | β |
PricingLocalized | string | null | No | HTML by default. |
IsVisible | boolean | null | No | β |
IsFree | boolean | null | No | β |
Currency | string | null | No | β |
AmountRecurrence | number | null | No | The recurring amount in cents. |
UnitRecurrence | string | null | No | β |
DurationTrial | number | null | No | β |
UnitTrial | string | null | No | β |
Features | JsonValue[] | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
list
offers.list
List the offers in a segment, optionally in a customer language and with their upgrade links
Risk: read
await corsair.proabono.api.offers.list({});
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceSegment | string | No | Your own identifier for the resource, unique within its kind. |
ReferenceCustomer | string | No | Read the offers in this customerβs language, with links for that customer. |
IsVisible | boolean | No | β |
IgnoreFeatures | boolean | No | Leave the feature list out of the answer. |
Language | string | No | β |
Html | boolean | No | False returns the pricing as plain text. |
Links | boolean | No | False leaves the links out. |
Page | number | No | 1-based page number. |
SizePage | number | No | Rows per page. |
| Name | Type | Required | Description |
|---|---|---|---|
offers | object[] | Yes | β |
Page | number | null | No | The page this answer holds, from 1. |
SizePage | number | null | No | Rows per page. |
Count | number | null | No | Rows on this page. |
TotalItems | number | null | No | Rows in the whole collection, across pages. |
offers full type
offers full type
{
Id?: number | null,
ReferenceOffer?: string | null,
IdSegment?: number | null,
ReferenceSegment?: string | null,
TitleLocalized?: string | null,
DescriptionLocalized?: string | null,
PricingLocalized?: string | null,
IsVisible?: boolean | null,
IsFree?: boolean | null,
Currency?: string | null,
AmountRecurrence?: number | null,
UnitRecurrence?: string | null,
DurationTrial?: number | null,
UnitTrial?: string | null,
Features?: JsonValue[] | null,
Links?: {
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
}[]
Subscriptions
create
subscriptions.create
Subscribe a customer to an offer, which starts billing when the offer is paid and the customer is billable. TryStart: false creates it without starting so it can be customised first
Risk: destructive
await corsair.proabono.api.subscriptions.create({ ReferenceOffer: 'premium', ReferenceCustomer: 'cust-42' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceOffer | string | Yes | Your own identifier for the resource, unique within its kind. |
ReferenceCustomer | string | Yes | The customer, which must already exist in ProAbono. |
ReferenceCustomerBuyer | string | No | When the buyer is not the recipient. |
Metadata | Record<string, JsonValue> | No | Your own key-value data, stored on the resource. |
EnsureBillable | boolean | No | Check paying information even for a free offer; a customer without any answers 403. |
TryStart | boolean | No | False creates without starting, so the subscription can be customised first; true forces a start. |
BillNow | boolean | No | Bill the start immediately. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
IdSegment | number | null | No | The ProAbono numeric id. |
IdOffer | number | null | No | The ProAbono numeric id. |
IdCustomer | number | null | No | The ProAbono numeric id. |
IdCustomerBuyer | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
ReferenceOffer | string | null | No | β |
ReferenceCustomer | string | null | No | β |
ReferenceCustomerBuyer | string | null | No | β |
Status | string | null | No | The lifecycle status, such as Active. |
StateSubscription | string | null | No | The detailed state, such as ActiveRunning. |
DateStart | string | null | No | β |
DatePeriodStart | string | null | No | β |
DatePeriodEnd | string | null | No | β |
DateTerm | string | null | No | β |
StatusAfterTerm | string | null | No | β |
StateSubscriptionAfterTerm | string | null | No | β |
IsTrial | boolean | null | No | β |
CountDaysTrial | number | null | No | β |
IsEngaged | boolean | null | No | β |
IsCustomerBillable | boolean | null | No | β |
IsPaymentCappingReached | boolean | null | No | β |
DateNextBilling | string | null | No | β |
TitleLocalized | string | null | No | β |
PricingSubtotal | number | null | No | In cents. |
PricingTotal | number | null | No | In cents, with taxes. |
AmountUpFront | number | null | No | β |
DurationTrial | number | null | No | β |
UnitTrial | string | null | No | β |
AmountRecurrence | number | null | No | β |
DurationRecurrence | number | null | No | β |
UnitRecurrence | string | null | No | β |
CountRecurrences | number | null | No | β |
CountMinRecurrences | number | null | No | β |
Features | JsonValue[] | null | No | β |
Metadata | JsonValue | null | No | β |
DateUpdate | string | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
get
subscriptions.get
Read one subscription with its state, period, next billing date and features. The docs warn against using this to check whether a user is a subscriber
Risk: read
await corsair.proabono.api.subscriptions.get({ IdSubscription: 44082 });
| Name | Type | Required | Description |
|---|---|---|---|
IdSubscription | number | Yes | The ProAbono numeric id. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
IdSegment | number | null | No | The ProAbono numeric id. |
IdOffer | number | null | No | The ProAbono numeric id. |
IdCustomer | number | null | No | The ProAbono numeric id. |
IdCustomerBuyer | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
ReferenceOffer | string | null | No | β |
ReferenceCustomer | string | null | No | β |
ReferenceCustomerBuyer | string | null | No | β |
Status | string | null | No | The lifecycle status, such as Active. |
StateSubscription | string | null | No | The detailed state, such as ActiveRunning. |
DateStart | string | null | No | β |
DatePeriodStart | string | null | No | β |
DatePeriodEnd | string | null | No | β |
DateTerm | string | null | No | β |
StatusAfterTerm | string | null | No | β |
StateSubscriptionAfterTerm | string | null | No | β |
IsTrial | boolean | null | No | β |
CountDaysTrial | number | null | No | β |
IsEngaged | boolean | null | No | β |
IsCustomerBillable | boolean | null | No | β |
IsPaymentCappingReached | boolean | null | No | β |
DateNextBilling | string | null | No | β |
TitleLocalized | string | null | No | β |
PricingSubtotal | number | null | No | In cents. |
PricingTotal | number | null | No | In cents, with taxes. |
AmountUpFront | number | null | No | β |
DurationTrial | number | null | No | β |
UnitTrial | string | null | No | β |
AmountRecurrence | number | null | No | β |
DurationRecurrence | number | null | No | β |
UnitRecurrence | string | null | No | β |
CountRecurrences | number | null | No | β |
CountMinRecurrences | number | null | No | β |
Features | JsonValue[] | null | No | β |
Metadata | JsonValue | null | No | β |
DateUpdate | string | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
list
subscriptions.list
List subscriptions filtered by customer, offer or segment, one page at a time
Risk: read
await corsair.proabono.api.subscriptions.list({ ReferenceCustomer: 'cust-42' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | No | Your own identifier for the resource, unique within its kind. |
ReferenceCustomerBuyer | string | No | Your own identifier for the resource, unique within its kind. |
ReferenceSegment | string | No | Your own identifier for the resource, unique within its kind. |
IgnoreFeatures | boolean | No | Leave the feature list out of the answer. |
Page | number | No | β |
SizePage | number | No | β |
| Name | Type | Required | Description |
|---|---|---|---|
subscriptions | object[] | Yes | β |
Page | number | null | No | The page this answer holds, from 1. |
SizePage | number | null | No | Rows per page. |
Count | number | null | No | Rows on this page. |
TotalItems | number | null | No | Rows in the whole collection, across pages. |
subscriptions full type
subscriptions full type
{
Id?: number | null,
IdSegment?: number | null,
IdOffer?: number | null,
IdCustomer?: number | null,
IdCustomerBuyer?: number | null,
ReferenceSegment?: string | null,
ReferenceOffer?: string | null,
ReferenceCustomer?: string | null,
ReferenceCustomerBuyer?: string | null,
Status?: string | null,
StateSubscription?: string | null,
DateStart?: string | null,
DatePeriodStart?: string | null,
DatePeriodEnd?: string | null,
DateTerm?: string | null,
StatusAfterTerm?: string | null,
StateSubscriptionAfterTerm?: string | null,
IsTrial?: boolean | null,
CountDaysTrial?: number | null,
IsEngaged?: boolean | null,
IsCustomerBillable?: boolean | null,
IsPaymentCappingReached?: boolean | null,
DateNextBilling?: string | null,
TitleLocalized?: string | null,
PricingSubtotal?: number | null,
PricingTotal?: number | null,
AmountUpFront?: number | null,
DurationTrial?: number | null,
UnitTrial?: string | null,
AmountRecurrence?: number | null,
DurationRecurrence?: number | null,
UnitRecurrence?: string | null,
CountRecurrences?: number | null,
CountMinRecurrences?: number | null,
Features?: JsonValue[] | null,
Metadata?: JsonValue | null,
DateUpdate?: string | null,
Links?: {
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
}[]
start
subscriptions.start
Start a subscription that was created without starting, which begins billing
Risk: destructive
await corsair.proabono.api.subscriptions.start({ IdSubscription: 44082 });
| Name | Type | Required | Description |
|---|---|---|---|
IdSubscription | number | Yes | The ProAbono numeric id. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
IdSegment | number | null | No | The ProAbono numeric id. |
IdOffer | number | null | No | The ProAbono numeric id. |
IdCustomer | number | null | No | The ProAbono numeric id. |
IdCustomerBuyer | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
ReferenceOffer | string | null | No | β |
ReferenceCustomer | string | null | No | β |
ReferenceCustomerBuyer | string | null | No | β |
Status | string | null | No | The lifecycle status, such as Active. |
StateSubscription | string | null | No | The detailed state, such as ActiveRunning. |
DateStart | string | null | No | β |
DatePeriodStart | string | null | No | β |
DatePeriodEnd | string | null | No | β |
DateTerm | string | null | No | β |
StatusAfterTerm | string | null | No | β |
StateSubscriptionAfterTerm | string | null | No | β |
IsTrial | boolean | null | No | β |
CountDaysTrial | number | null | No | β |
IsEngaged | boolean | null | No | β |
IsCustomerBillable | boolean | null | No | β |
IsPaymentCappingReached | boolean | null | No | β |
DateNextBilling | string | null | No | β |
TitleLocalized | string | null | No | β |
PricingSubtotal | number | null | No | In cents. |
PricingTotal | number | null | No | In cents, with taxes. |
AmountUpFront | number | null | No | β |
DurationTrial | number | null | No | β |
UnitTrial | string | null | No | β |
AmountRecurrence | number | null | No | β |
DurationRecurrence | number | null | No | β |
UnitRecurrence | string | null | No | β |
CountRecurrences | number | null | No | β |
CountMinRecurrences | number | null | No | β |
Features | JsonValue[] | null | No | β |
Metadata | JsonValue | null | No | β |
DateUpdate | string | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
suspend
subscriptions.suspend
Suspend a subscription without terminating it
Risk: write
await corsair.proabono.api.subscriptions.suspend({ IdSubscription: 44082 });
| Name | Type | Required | Description |
|---|---|---|---|
IdSubscription | number | Yes | The ProAbono numeric id. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
IdSegment | number | null | No | The ProAbono numeric id. |
IdOffer | number | null | No | The ProAbono numeric id. |
IdCustomer | number | null | No | The ProAbono numeric id. |
IdCustomerBuyer | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
ReferenceOffer | string | null | No | β |
ReferenceCustomer | string | null | No | β |
ReferenceCustomerBuyer | string | null | No | β |
Status | string | null | No | The lifecycle status, such as Active. |
StateSubscription | string | null | No | The detailed state, such as ActiveRunning. |
DateStart | string | null | No | β |
DatePeriodStart | string | null | No | β |
DatePeriodEnd | string | null | No | β |
DateTerm | string | null | No | β |
StatusAfterTerm | string | null | No | β |
StateSubscriptionAfterTerm | string | null | No | β |
IsTrial | boolean | null | No | β |
CountDaysTrial | number | null | No | β |
IsEngaged | boolean | null | No | β |
IsCustomerBillable | boolean | null | No | β |
IsPaymentCappingReached | boolean | null | No | β |
DateNextBilling | string | null | No | β |
TitleLocalized | string | null | No | β |
PricingSubtotal | number | null | No | In cents. |
PricingTotal | number | null | No | In cents, with taxes. |
AmountUpFront | number | null | No | β |
DurationTrial | number | null | No | β |
UnitTrial | string | null | No | β |
AmountRecurrence | number | null | No | β |
DurationRecurrence | number | null | No | β |
UnitRecurrence | string | null | No | β |
CountRecurrences | number | null | No | β |
CountMinRecurrences | number | null | No | β |
Features | JsonValue[] | null | No | β |
Metadata | JsonValue | null | No | β |
DateUpdate | string | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
terminate
subscriptions.terminate
Terminate a subscription, ending it for good; by default at the end of the current period. A later start cannot revive it
Risk: destructive
await corsair.proabono.api.subscriptions.terminate({ IdSubscription: 44082 });
| Name | Type | Required | Description |
|---|---|---|---|
IdSubscription | number | Yes | The ProAbono numeric id. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
IdSegment | number | null | No | The ProAbono numeric id. |
IdOffer | number | null | No | The ProAbono numeric id. |
IdCustomer | number | null | No | The ProAbono numeric id. |
IdCustomerBuyer | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
ReferenceOffer | string | null | No | β |
ReferenceCustomer | string | null | No | β |
ReferenceCustomerBuyer | string | null | No | β |
Status | string | null | No | The lifecycle status, such as Active. |
StateSubscription | string | null | No | The detailed state, such as ActiveRunning. |
DateStart | string | null | No | β |
DatePeriodStart | string | null | No | β |
DatePeriodEnd | string | null | No | β |
DateTerm | string | null | No | β |
StatusAfterTerm | string | null | No | β |
StateSubscriptionAfterTerm | string | null | No | β |
IsTrial | boolean | null | No | β |
CountDaysTrial | number | null | No | β |
IsEngaged | boolean | null | No | β |
IsCustomerBillable | boolean | null | No | β |
IsPaymentCappingReached | boolean | null | No | β |
DateNextBilling | string | null | No | β |
TitleLocalized | string | null | No | β |
PricingSubtotal | number | null | No | In cents. |
PricingTotal | number | null | No | In cents, with taxes. |
AmountUpFront | number | null | No | β |
DurationTrial | number | null | No | β |
UnitTrial | string | null | No | β |
AmountRecurrence | number | null | No | β |
DurationRecurrence | number | null | No | β |
UnitRecurrence | string | null | No | β |
CountRecurrences | number | null | No | β |
CountMinRecurrences | number | null | No | β |
Features | JsonValue[] | null | No | β |
Metadata | JsonValue | null | No | β |
DateUpdate | string | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
updateTerm
subscriptions.updateTerm
Change a subscriptionβs end date
Risk: write
await corsair.proabono.api.subscriptions.updateTerm({ IdSubscription: 44082, DateTerm: '2026-12-31T00:00:00Z' });
| Name | Type | Required | Description |
|---|---|---|---|
IdSubscription | number | Yes | The ProAbono numeric id. |
DateTerm | string | Yes | The new end date, as an ISO 8601 timestamp. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
IdSegment | number | null | No | The ProAbono numeric id. |
IdOffer | number | null | No | The ProAbono numeric id. |
IdCustomer | number | null | No | The ProAbono numeric id. |
IdCustomerBuyer | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
ReferenceOffer | string | null | No | β |
ReferenceCustomer | string | null | No | β |
ReferenceCustomerBuyer | string | null | No | β |
Status | string | null | No | The lifecycle status, such as Active. |
StateSubscription | string | null | No | The detailed state, such as ActiveRunning. |
DateStart | string | null | No | β |
DatePeriodStart | string | null | No | β |
DatePeriodEnd | string | null | No | β |
DateTerm | string | null | No | β |
StatusAfterTerm | string | null | No | β |
StateSubscriptionAfterTerm | string | null | No | β |
IsTrial | boolean | null | No | β |
CountDaysTrial | number | null | No | β |
IsEngaged | boolean | null | No | β |
IsCustomerBillable | boolean | null | No | β |
IsPaymentCappingReached | boolean | null | No | β |
DateNextBilling | string | null | No | β |
TitleLocalized | string | null | No | β |
PricingSubtotal | number | null | No | In cents. |
PricingTotal | number | null | No | In cents, with taxes. |
AmountUpFront | number | null | No | β |
DurationTrial | number | null | No | β |
UnitTrial | string | null | No | β |
AmountRecurrence | number | null | No | β |
DurationRecurrence | number | null | No | β |
UnitRecurrence | string | null | No | β |
CountRecurrences | number | null | No | β |
CountMinRecurrences | number | null | No | β |
Features | JsonValue[] | null | No | β |
Metadata | JsonValue | null | No | β |
DateUpdate | string | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
upgrade
subscriptions.upgrade
Move a subscription to another offer, which changes what it bills from the next period
Risk: destructive
await corsair.proabono.api.subscriptions.upgrade({ IdSubscription: 44082, ReferenceOffer: 'ultimate' });
| Name | Type | Required | Description |
|---|---|---|---|
IdSubscription | number | Yes | The ProAbono numeric id. |
ReferenceOffer | string | Yes | The offer to move the subscription to. |
| Name | Type | Required | Description |
|---|---|---|---|
Id | number | null | No | The ProAbono numeric id. |
IdSegment | number | null | No | The ProAbono numeric id. |
IdOffer | number | null | No | The ProAbono numeric id. |
IdCustomer | number | null | No | The ProAbono numeric id. |
IdCustomerBuyer | number | null | No | The ProAbono numeric id. |
ReferenceSegment | string | null | No | β |
ReferenceOffer | string | null | No | β |
ReferenceCustomer | string | null | No | β |
ReferenceCustomerBuyer | string | null | No | β |
Status | string | null | No | The lifecycle status, such as Active. |
StateSubscription | string | null | No | The detailed state, such as ActiveRunning. |
DateStart | string | null | No | β |
DatePeriodStart | string | null | No | β |
DatePeriodEnd | string | null | No | β |
DateTerm | string | null | No | β |
StatusAfterTerm | string | null | No | β |
StateSubscriptionAfterTerm | string | null | No | β |
IsTrial | boolean | null | No | β |
CountDaysTrial | number | null | No | β |
IsEngaged | boolean | null | No | β |
IsCustomerBillable | boolean | null | No | β |
IsPaymentCappingReached | boolean | null | No | β |
DateNextBilling | string | null | No | β |
TitleLocalized | string | null | No | β |
PricingSubtotal | number | null | No | In cents. |
PricingTotal | number | null | No | In cents, with taxes. |
AmountUpFront | number | null | No | β |
DurationTrial | number | null | No | β |
UnitTrial | string | null | No | β |
AmountRecurrence | number | null | No | β |
DurationRecurrence | number | null | No | β |
UnitRecurrence | string | null | No | β |
CountRecurrences | number | null | No | β |
CountMinRecurrences | number | null | No | β |
Features | JsonValue[] | null | No | β |
Metadata | JsonValue | null | No | β |
DateUpdate | string | null | No | β |
Links | object[] | null | No | Links for the resource, including the encrypted portal URL. |
Links full type
Links full type
{
rel?: string | null,
href?: string | null,
query?: string | null
}[] | null
Usages
get
usages.get
Read one customerβs usage of one feature: on/off, or the included and current quantities
Risk: read
await corsair.proabono.api.usages.get({ ReferenceCustomer: 'cust-42', ReferenceFeature: 'feat-users' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | Yes | Your own identifier for the resource, unique within its kind. |
ReferenceFeature | string | Yes | Your own identifier for the resource, unique within its kind. |
IdSubscription | number | No | Read the usage of this subscription when the customer has several. |
| Name | Type | Required | Description |
|---|---|---|---|
IdSegment | number | null | No | The ProAbono numeric id. |
IdFeature | number | null | No | The ProAbono numeric id. |
IdCustomer | number | null | No | The ProAbono numeric id. |
IdSubscription | number | null | No | Absent when several subscriptions match the usage. |
ReferenceSegment | string | null | No | β |
ReferenceFeature | string | null | No | β |
ReferenceCustomer | string | null | No | β |
TypeFeature | string | null | No | OnOff, Limitation or Consumption. |
IsIncluded | boolean | null | No | OnOff features only. |
IsEnabled | boolean | null | No | OnOff features only. |
QuantityIncluded | number | null | No | Included quantity; absent means unlimited. |
QuantityCurrent | number | null | No | Quantity used so far. |
DatePeriodStart | string | null | No | β |
DatePeriodEnd | string | null | No | β |
increment
usages.increment
Add to a featureβs usage for a customer, which ProAbono bills when it exceeds the included quantity. A negative increment subtracts, which is how a reversed action is recorded
Risk: destructive
await corsair.proabono.api.usages.increment({ ReferenceCustomer: 'cust-42', ReferenceFeature: 'feat-users', Increment: 1, DateStamp: '2026-11-15T10:00:00Z' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | Yes | Your own identifier for the resource, unique within its kind. |
ReferenceFeature | string | Yes | Your own identifier for the resource, unique within its kind. |
IdSubscription | number | No | The ProAbono numeric id. |
Increment | number | Yes | How much to add. A negative value subtracts. |
DateStamp | string | Yes | When the change happened, as an ISO 8601 timestamp. ProAbono records two changes with the same timestamp once, so it doubles as an idempotency key. |
EnsureBillable | boolean | No | True by default on ProAbono: a customer without valid payment information answers 403. False skips that check. |
| Name | Type | Required | Description |
|---|---|---|---|
IdSegment | number | null | No | The ProAbono numeric id. |
IdFeature | number | null | No | The ProAbono numeric id. |
IdCustomer | number | null | No | The ProAbono numeric id. |
IdSubscription | number | null | No | Absent when several subscriptions match the usage. |
ReferenceSegment | string | null | No | β |
ReferenceFeature | string | null | No | β |
ReferenceCustomer | string | null | No | β |
TypeFeature | string | null | No | OnOff, Limitation or Consumption. |
IsIncluded | boolean | null | No | OnOff features only. |
IsEnabled | boolean | null | No | OnOff features only. |
QuantityIncluded | number | null | No | Included quantity; absent means unlimited. |
QuantityCurrent | number | null | No | Quantity used so far. |
DatePeriodStart | string | null | No | β |
DatePeriodEnd | string | null | No | β |
list
usages.list
List feature usages by customer, feature or subscription, one page at a time
Risk: read
await corsair.proabono.api.usages.list({ ReferenceCustomer: 'cust-42' });
| Name | Type | Required | Description |
|---|---|---|---|
ReferenceCustomer | string | No | Your own identifier for the resource, unique within its kind. |
ReferenceFeature | string | No | Your own identifier for the resource, unique within its kind. |
IdSubscription | number | No | The ProAbono numeric id. |
Page | number | No | 1-based page number. |
SizePage | number | No | Rows per page. |
| Name | Type | Required | Description |
|---|---|---|---|
usages | object[] | Yes | β |
Page | number | null | No | The page this answer holds, from 1. |
SizePage | number | null | No | Rows per page. |
Count | number | null | No | Rows on this page. |
TotalItems | number | null | No | Rows in the whole collection, across pages. |
usages full type
usages full type
{
IdSegment?: number | null,
IdFeature?: number | null,
IdCustomer?: number | null,
IdSubscription?: number | null,
ReferenceSegment?: string | null,
ReferenceFeature?: string | null,
ReferenceCustomer?: string | null,
TypeFeature?: string | null,
IsIncluded?: boolean | null,
IsEnabled?: boolean | null,
QuantityIncluded?: number | null,
QuantityCurrent?: number | null,
DatePeriodStart?: string | null,
DatePeriodEnd?: string | null
}[]
update
usages.update
Update up to 50 usages in one call, each by increment, current quantity or on/off
Risk: destructive
await corsair.proabono.api.usages.update({ usages: [{ ReferenceCustomer: 'cust-42', ReferenceFeature: 'feat-users', Increment: 1, DateStamp: '2026-11-15T10:00:00Z' }] });
| Name | Type | Required | Description |
|---|---|---|---|
usages | object[] | Yes | ProAbono asks for at most 50 rows per call. |
usages full type
usages full type
{
ReferenceCustomer: string,
ReferenceFeature: string,
IdSubscription?: number,
Increment?: number,
QuantityCurrent?: number,
IsEnabled?: boolean,
DateStamp: string
}[]
| Name | Type | Required | Description |
|---|---|---|---|
usages | object[] | Yes | β |
usages full type
usages full type
{
IdSegment?: number | null,
IdFeature?: number | null,
IdCustomer?: number | null,
IdSubscription?: number | null,
ReferenceSegment?: string | null,
ReferenceFeature?: string | null,
ReferenceCustomer?: string | null,
TypeFeature?: string | null,
IsIncluded?: boolean | null,
IsEnabled?: boolean | null,
QuantityIncluded?: number | null,
QuantityCurrent?: number | null,
DatePeriodStart?: string | null,
DatePeriodEnd?: string | null
}[]