ProAbono - API Live

http://docs.proabono.com/api/
Admin
ProAbono automates subscription management and recurring billing. It handles flexible pricing...
Tokens:227,916
Snippets:1,019
Trust Score:7.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### Quote a Subscription Start Example Request

Source: https://docs.proabono.com/api

Provides an example of a POST request to the subscription start pricing endpoint.

```http
POST https://api-42.proabono.com/v1/Pricing/Subscription/45678/Start?Html=false
```

--------------------------------

### List Offers Example Request

Source: https://docs.proabono.com/api/backoffice

An example of a GET request to list offers, including optional parameters for pagination.

```http
GET https://via.proabono.com/Sub/Offers/?IdBusiness=42&SizePage=3
```

--------------------------------

### List Subscription Discounts Example Request

Source: https://docs.proabono.com/api/backoffice

An example GET request to retrieve subscription discounts for a specific business and subscription.

```http
GET https://via.proabono.com/Sub/SubscriptionDiscounts/?IdBusiness=42&IdSubscription=645
```

--------------------------------

### List Discounts Example Request

Source: https://docs.proabono.com/api/backoffice

An example of a GET request to list discounts, specifying Business ID and page size.

```http
GET https://via.proabono.com/Sub/Discounts/?IdBusiness=42&SizePage=3
```

--------------------------------

### Example GET Request with Query Parameters

Source: https://docs.proabono.com/api

Demonstrates how to combine multiple optional query parameters in a GET request to the Offers API to retrieve specific offer data.

```http
GET https://api-42.proabono.com/v1/Offers?SizePage=20&html=false&IgnoreFeatures=true&language=en
```

--------------------------------

### List PricingTableOffers Example Request

Source: https://docs.proabono.com/api/backoffice

An example GET request to list PricingTableOffers, specifying both IdBusiness and IdPricingTable.

```http
GET https://via.proabono.com/Sub/PricingTableOffers/?IdBusiness=42&IdPricingTable=2
```

--------------------------------

### Example List Features Request

Source: https://docs.proabono.com/api/backoffice

An example GET request to list features for a business with ID 42.

```http
GET https://via.proabono.com/Organization/Features/?IdBusiness=42
```

--------------------------------

### Compute Offer Pricing Example Request

Source: https://docs.proabono.com/api/backoffice

An example of a GET request to simulate offer pricing for a specific offer and customer.

```http
GET https://via.proabono.com/Sub/Offers/152867/Simulation?IdCustomer=123456
```

--------------------------------

### Quote a Subscription Start Example Response

Source: https://docs.proabono.com/api

Illustrates a successful JSON response for a subscription start pricing quote, including detailed pricing and period information.

```json
{
    "IdSubscription": 45678,
    "AmountTotalDue": 31875,
    "PricingLocalized": "&euro; 318.75",
    "DatePeriodStart": "2025-08-10T07:41:57.83Z",
    "DatePeriodEnd": "2025-09-10T07:41:57.83Z",
    "AmountSubtotal": 25000,
    "AmountTotal": 31875,
    "Details": [
        {
            "IdSubscription": 45678,
            "LabelLocalized": "Subscription amount",
            "AmountTotalDue": 31875,
            "DatePeriodStart": "2025-08-10T07:41:57.83Z",
            "DatePeriodEnd": "2025-09-10T07:41:57.83Z",
            "AmountSubtotal": 25000,
            "AmountTotal": 31875
        }
    ],
    "NextTerm": {
        "IdSubscription": 45678,
        "AmountTotalDue": 31875,
        "PricingLocalized": "&euro; 318.75",
        "DatePeriodStart": "2025-09-10T07:41:57.83Z",
        "DatePeriodEnd": "2025-10-10T07:41:57.83Z",
        "AmountSubtotal": 25000,
        "AmountTotal": 31875,
        "Details": [
            {
                "IdSubscription": 45678,
                "LabelLocalized": "Subscription amount",
                "AmountTotalDue": 31875,
                "DatePeriodStart": "2025-09-10T07:41:57.83Z",
                "DatePeriodEnd": "2025-10-10T07:41:57.83Z",
                "AmountSubtotal": 25000,
                "AmountTotal": 31875
            }
        ]
    }
}
```

--------------------------------

### List Customers Example Request

Source: https://docs.proabono.com/api/backoffice

An example GET request to list customers associated with a specific business ID.

```http
GET https://via.proabono.com/Distribution/Customers/?IdBusiness=42
```

--------------------------------

### List SubscriptionFeatures Example Request

Source: https://docs.proabono.com/api/backoffice

An example GET request to list subscription features, specifying business and subscription IDs.

```http
GET https://via.proabono.com/Sub/SubscriptionFeatures/?IdBusiness=42&IdSubscription=645
```

--------------------------------

### Example Subscription Creation Response

Source: https://docs.proabono.com/api

This is an example of a successful response when creating a subscription with a future start date. It includes details of the created subscription and associated links.

```json
{
    "Id": 423427,
    "IdSegment": 69,
    "IdOffer": 6994,
    "IdCustomer": 133700,
    "IdCustomerBuyer": 133700,
    "ReferenceSegment": "demo-eur",
    "ReferenceOffer": "offer-premium",
    "ReferenceCustomer": "cust-42",
    "ReferenceCustomerBuyer": "cust-42",
    "PricingSubtotal": 4900,
    "PricingTotal": 4900,
    "Status": "Draft",
    "StateSubscription": "DraftDelayedStart",
    "DateStart": "2098-02-14T23:59:59.65Z",
    "DateTerm": "2098-02-14T23:59:59.65Z",
    "StatusAfterTerm": "Active",
    "StateSubscriptionAfterTerm": "ActiveRunning",
    "IsEngaged": false,
    "IsCustomerBillable": true,
    "IsPaymentCappingReached": false,
    "DateNextBilling": "2025-03-27T06:00:00.00Z",
    "TitleLocalized": "Premium",
    "PricingLocalized": "<span class=\"best-price\">à partir de</span> <span class=\"amount\"><span class=\"amount-value\">0.00</span>&nbsp;<span class=\"currency-value\">€</span></span><span class=\"frequency\">/mois</span>",
    "AmountUpFront": 0,
    "AmountRecurrence": 4900,
    "DurationRecurrence": 1,
    "UnitRecurrence": "Month",
    "Features": [
        {
            "Id": 47,
            "ReferenceFeature": "feat-module-a",
            "IsVisible": true,
            "Properties": "None",
            "TitleLocalized": "Module A",
            "TypeFeature": "OnOff",
            "IsIncluded": true,
            "IsEnabled": true
        },
        {
            "Id": 48,
            "ReferenceFeature": "feat-users",
            "IsVisible": true,
            "Properties": "None",
            "TitleLocalized": "Utilisateurs",
            "PricingLocalized": "<span class=\"amount\">+<span class=\"amount-value\">12.00</span>&nbsp;<span class=\"currency-value\">€</span></span>/unité&nbsp;supp.",
            "TypeFeature": "Limitation",
            "QuantityIncluded": 2,
            "QuantityCurrent": 0
        },
        {
            "Id": 49,
            "ReferenceFeature": "feat-module-b",
            "IsVisible": true,
            "Properties": "None",
            "TitleLocalized": "Module B",
            "DescriptionLocalized": "Ce module est simplement fabuleux. Il vous facilitera grandement la vie.",
            "PricingLocalized": "en&nbsp;option <span class=\"amount\">+<span class=\"amount-value\">25.00</span>&nbsp;<span class=\"currency-value\">€</span></span>",
            "TypeFeature": "OnOff",
            "IsIncluded": false,
            "IsEnabled": false
        },
        {
            "Id": 243,
            "ReferenceFeature": "feat-agent",
            "IsVisible": true,
            "Properties": "None",
            "TitleLocalized": "Agents",
            "PricingLocalized": "<span class=\"amount\">+<span class=\"amount-value\">10.00</span>&nbsp;<span class=\"currency-value\">€</span></span>/unité&nbsp;supp.",
            "TypeFeature": "Limitation",
            "QuantityIncluded": 5,
            "QuantityCurrent": 5
        }
    ],
    "DateUpdate": "2025-03-12T13:47:33.40Z",
    "Links": [
        {
            "rel": "self",
            "href": "/v1/Subscription/423427"
        },
         {
            "rel": "insite-home",
            "href": "https://demo-eur.proabono.com/portal-auth/{Unique-Encrypted-URL1}"
        },
        {
            "rel": "insite-related-subscription",
            "query": "{Unique-Encrypted-Query-Parameter1}"
        },
        {
            "rel": "insite-register",
            "query": "{Unique-Encrypted-Query-Parameter2}"
        },
        {
            "rel": "insite-upgrade",
            "query": "{Unique-Encrypted-Query-Parameter3}"
        },
        {
            "rel": "related-quote",
            "href": "/v1/Pricing/Subscription/423427?ensureBillable=False"
        }
    ]
}
```

--------------------------------

### Compute Subscription Pricing - Example Request

Source: https://docs.proabono.com/api/backoffice

An example GET request to the subscription pricing endpoint, specifying a subscription ID.

```http
GET https://via.proabono.com/Sub/Subscriptions/644/Quote
```

--------------------------------

### List Subscription Periods Example Request

Source: https://docs.proabono.com/api/backoffice

An example GET request to list subscription periods for a specific business ID.

```http
GET https://via.proabono.com/Sub/SubscriptionPeriods/?IdBusiness=42
```

--------------------------------

### List All Invoices and Credit Notes Example Request

Source: https://docs.proabono.com/api/backoffice

Example of a GET request to list all invoices and credit notes, specifying a Business ID.

```http
GET https://via.proabono.com/Finance/Invoices/?IdBusiness=42
```

--------------------------------

### List SubscriptionFeatures Combined Parameters Example

Source: https://docs.proabono.com/api/backoffice

An example GET request demonstrating how to combine query parameters to filter subscription features by business, feature ID, and update date.

```http
GET /Sub/SubscriptionFeatures/?IdBusiness=42&IdFeature=238&DateUpdateMin=2025-08-27T13:54:00
```

--------------------------------

### Get Customer Request

Source: https://docs.proabono.com/api/backoffice

Example of a GET request to retrieve customer data by ID.

```http
GET https://via.proabono.com/Distribution/Customers/42
```

--------------------------------

### Get Customer Request

Source: https://docs.proabono.com/api

Example of a GET request to retrieve customer information using their ReferenceCustomer.

```http
GET https://api-42.proabono.com/v1/Customer?ReferenceCustomer=cust-42
```

--------------------------------

### List TaxProfileExceptions Example Request

Source: https://docs.proabono.com/api/backoffice-for-platform

An example GET request to retrieve TaxProfileExceptions for a specific Business ID.

```http
GET https://via.proabono.com/Organization/TaxProfileExceptions/?IdBusiness=2
```

--------------------------------

### Create Subscription with Custom Discounts

Source: https://docs.proabono.com/api

This example shows how to apply custom discounts to a subscription during creation by referencing predefined discount codes. Discounts can be applied to upfront fees or recurring subscription fees.

```json
{
    "ReferenceCustomer": "cust-42",
    "ReferenceOffer": "offer-premium-pro-plus",
    "Discounts": [
        { "ReferenceDiscount": "50percent-upfrontfee" },    
        { "ReferenceDiscount": "30percent-subscriptionfee" }    
    ]
}
```

--------------------------------

### Create Subscription with Custom Features

Source: https://docs.proabono.com/api

This example demonstrates how to create a subscription by overriding default offer features and adding new ones. It shows how to enable/disable features, set quantities and prices for users and agents, and add entirely new modules.

```json
{
    "offerId": "{Offer-ID}",
    "features": [
        {
            "id": "{Module-A-ID}",
            "enabled": true
        },
        {
            "id": "{Module-B-ID}",
            "enabled": true,
            "price": 15.00
        },
        {
            "id": "{Users-ID}",
            "quantity": 10,
            "included": 3
        },
        {
            "id": "{Agents-ID}",
            "quantity": 20,
            "included": 5,
            "price": 40.00
        },
        {
            "id": "{Module-C-ID}",
            "enabled": true
        }
    ]
}
```

--------------------------------

### Example Request to List Customers

Source: https://docs.proabono.com/api

An example of a GET request to retrieve a list of customers from the ProAbono API.

```http
GET https://api-42.proabono.com/v1/Customers
```

--------------------------------

### Compute Offer Pricing Example Response 1 - Offer with free trial

Source: https://docs.proabono.com/api/backoffice

Example response for an offer that includes a free trial period. The total amount due is zero.

```json
{
    "DateGeneration": "2025-09-11T09:32:04.66Z",
    "AmountSubtotal": 0,
    "AmountTotalDue": 0,
    "Details": [
        {
            "TypeMove": "SubscriptionInitialFee",
            "Label": "Trial amount",
            "AmountSubtotal": 0,
            "AmountTotalDue": 0
        }
    ],
    "NextTerm": {
        "AmountSubtotal": 9900,
        "AmountTotalDue": 11632,
        "Details": [
            {
                "TypeMove": "SubscriptionRecurringAmount",
                "Label": "Subscription amount",
                "AmountSubtotal": 9900,
                "AmountTotalDue": 11632,
                "Tax1": {
                    "IdTaxProfile": 252,
                    "Label": "Tax1",
                    "Rate": 1000,
                    "Amount": 990,
                    "Type": "Standard"
                },
                "Tax2": {
                    "IdTaxProfile": 253,
                    "Label": "Tax2",
                    "Rate": 750,
                    "Amount": 742,
                    "Type": "Standard"
                }
            }
        ]
    }
}
```

--------------------------------

### List CustomerEvents Example Request

Source: https://docs.proabono.com/api/backoffice

An example GET request to list customer events for a specific business ID.

```http
GET https://via.proabono.com/Notification/CustomerEvents?IdBusiness=42
```

--------------------------------

### Example Subscription Creation Request

Source: https://docs.proabono.com/api

An example of a POST request to create a subscription, including customer and offer references, and metadata.

```json
POST https://api-42.proabono.com/v1/Subscription
{
    "ReferenceCustomer": "cust-42",
    "ReferenceOffer": "offer-premium-pro-plus",
    "Metadata":
        {
            "Site": "www.johndoe.com",
            "AccountingReference":"456-xyz",
            "IdPartner": 3
        }
}
```

--------------------------------

### Example Subscription Creation Response

Source: https://docs.proabono.com/api

An example response after successfully creating a subscription, detailing its properties, pricing, features, and associated links.

```json
{
    "Id": 44088,
    "IdSegment": 69,
    "IdOffer": 147,
    "IdCustomer": 133700,
    "IdCustomerBuyer": 133700,
    "ReferenceSegment": "demo-eur",
    "ReferenceOffer": "offer-premium-pro-plus",
    "ReferenceCustomer": "cust-42",
    "ReferenceCustomerBuyer": "cust-42",
    "PricingSubtotal": 25000,
    "PricingTotal": 25000,
    "Status": "Active",
    "StateSubscription": "ActiveRunning",
    "DateStart": "2025-02-12T10:10:44.00Z",
    "DatePeriodStart": "2025-02-12T10:10:44.00Z",
    "DatePeriodEnd": "2025-03-12T10:10:44.00Z",
    "DateTerm": "2025-03-12T10:10:44.00Z",
    "DateResetConsumption": "2025-03-12T10:10:44.00Z",
    "StatusAfterTerm": "Active",
    "StateSubscriptionAfterTerm": "ActiveRunning",
    "IsEngaged": false,
    "IsCustomerBillable": false,
    "IsPaymentCappingReached": false,
    "DateNextBilling": "2025-02-12T15:34:19.00Z",
    "TitleLocalized": "Premium Pro+",
    "PricingLocalized": "<span class=\"best-price\">à partir de</span> <span class=\"amount\"><span class=\"amount-value\">0.00</span>&nbsp;<span class=\"currency-value\">€</span></span><span class=\"frequency\">/mois</span>",
    "DurationTrial": 0,
    "AmountRecurrence": 25000,
    "DurationRecurrence": 1,
    "UnitRecurrence": "Month",
    "Metadata":
        {
            "Site": "www.johndoe.com",
            "AccountingReference":"456-xyz",
            "IdPartner": 3
        },
    "Features": [
        {
            "Id": 47,
            "ReferenceFeature": "feat-module-a",
            "IsVisible": true,
            "Properties": "UpdatableBeforeSubscription, UpdateAtFullPrice",
            "TitleLocalized": "Module A",
            "PricingLocalized": "<span class=\"amount\">+<span class=\"amount-value\">50.00</span>&nbsp;<span class=\"currency-value\">€</span></span>/unité&nbsp;supp.",
            "TypeFeature": "OnOff",
            "IsIncluded": true,
            "IsEnabled": true
        },
        {
            "Id": 48,
            "ReferenceFeature": "feat-users",
            "IsVisible": true,
            "Properties": "UpdatableBeforeSubscription, UpdateAtFullPrice",
            "TitleLocalized": "Active Users",
            "PricingLocalized": "<span class=\"amount\">+<span class=\"amount-value\">50.00</span>&nbsp;<span class=\"currency-value\">€</span></span>/unité&nbsp;supp.",
            "TypeFeature": "Limitation",
            "QuantityIncluded": 10,
            "QuantityCurrent": 10
        },
        {
            "Id": 49,
            "ReferenceFeature": "feat-module-b",
            "IsVisible": true,
            "Properties": "UpdatableBeforeSubscription, UpdateAtFullPrice",
            "TitleLocalized": "Module B",
            "PricingLocalized": "<span class=\"amount\">+<span class=\"amount-value\">50.00</span>&nbsp;<span class=\"currency-value\">€</span></span>/unité&nbsp;supp.",
            "DescriptionLocalized": "This module is awesome. It revolutionizes your life.",
            "TypeFeature": "OnOff",
            "IsIncluded": true,
            "IsEnabled": true
        },
        {
            "Id": 50,
            "ReferenceFeature": "feat-text-messages",
            "IsVisible": true,
            "Properties": "UpdatableBeforeSubscription, UpdateAtFullPrice",
            "TitleLocalized": "Text Messages Sent",
            "PricingLocalized": "<span class=\"amount\">+<span class=\"amount-value\">50.00</span>&nbsp;<span class=\"currency-value\">€</span></span>/unité&nbsp;supp.",
            "TypeFeature": "Consumption",
            "QuantityIncluded": 100,
            "QuantityCurrent": 0
        }
    ],
    "DateUpdate": "2025-08-09T13:17:39.88Z",
    "Links": [
        {
            "rel": "self",
            "href": "/v1/Subscription/44088"
        },
        {
            "rel": "insite-home",
            "href": "https://demo-eur.proabono.com/portal-auth/{Unique-Encrypted-URL1}"
        },          
        {
            "rel": "insite-related-subscription",
            "query": "{Unique-Encrypted-Query-Parameter1}"
        },
        {
            "rel": "insite-upgrade",
            "query": "{Unique-Encrypted-Query-Parameter2}"
        },
        {
            "rel": "related-quote",
            "href": "/v1/Pricing/Subscription/44088?ensureBillable=False"
        }
    ]
}
```

--------------------------------

### List CustomerMoves Example Request

Source: https://docs.proabono.com/api/backoffice

An example GET request to list customer moves for a specific business ID.

```http
GET https://via.proabono.com/Finance/CustomerMoves/?IdBusiness=42
```

--------------------------------

### List Businesses - Example with Query Parameters

Source: https://docs.proabono.com/api/backoffice-for-platform

Demonstrates combining query parameters to filter businesses by StateLife and update date.

```http
GET /Organization/Businesses/?StateLife=Ok&dateUpdateMin=2023-04-27T06:54:00
```

--------------------------------

### Retrieve Gateway Request Example Request

Source: https://docs.proabono.com/api/backoffice-for-platform

Example of a GET request to retrieve a gateway request with ID 68.

```http
GET https://via.proabono.com/Gateway/GatewayRequests/68
```

--------------------------------

### Retrieve Mandate Permission Example Request

Source: https://docs.proabono.com/api/backoffice-for-platform

Example GET request to retrieve a mandate permission with a specific ID.

```HTTP
GET https://via.proabono.com/Gateway/GatewayPermissions/25
```

--------------------------------

### Example Subscription Creation Response

Source: https://docs.proabono.com/api

This is an example response received after successfully creating a subscription with a custom free trial period. It includes details about the subscription, its trial status, and billing information.

```json
{
    "Id": 430258,
    "IdSegment": 69,
    "IdOffer": 6994,
    "IdCustomer": 133700,
    "IdCustomerBuyer": 133700,
    "ReferenceSegment": "demo-eur",
    "ReferenceOffer": "offer-premium",
    "ReferenceCustomer": "cust-42",
    "ReferenceCustomerBuyer": "cust-42",
    "PricingSubtotal": 4900,
    "PricingTotal": 4900,
    "Status": "Active",  
    "StateSubscription": "ActiveRunning", 
    "DateStart": "2025-03-25T17:45:43.00Z",
    "DatePeriodStart": "2025-03-25T17:45:43.00Z",
    "DatePeriodEnd": "2025-04-15T17:45:43.00Z",
    "DateTerm": "2025-04-15T17:45:43.00Z",
    "DateResetConsumption": "2025-04-15T17:45:43.00Z",
    "StatusAfterTerm": "Active",
    "StateSubscriptionAfterTerm": "ActiveRunning",
    "IsTrial": true,
    "CountDaysTrial": 20,
    "IsEngaged": false,
    "IsCustomerBillable": true,
    "IsPaymentCappingReached": false,
    "DateNextBilling": "2025-03-27T06:00:00.00Z",
    "TitleLocalized": "Premium",
    "PricingLocalized": "<span class=\"best-price\">à partir de</span> <span class=\"amount\"> <span class=\"amount-value\">0.00</span>&nbsp;<span class=\"currency-value\">€</span></span><span class=\"frequency\">/mois</span>",
    "AmountUpFront": 100000,
    "DurationTrial": 21,
    "UnitTrial": "Day",
    "AmountRecurrence": 4900,
    "DurationRecurrence": 1,
    "UnitRecurrence": "Month",
    "Features": [
        {
            "Id": 47,
            "ReferenceFeature": "feat-module-a",
            "IsVisible": true,
            "Properties": "None",
            "TitleLocalized": "Module A",
            "TypeFeature": "OnOff",
            "IsIncluded": true,
            "IsEnabled": true
        },
        {
            "Id": 48,
            "ReferenceFeature": "feat-users",
            "IsVisible": true,
            "Properties": "None",
            "TitleLocalized": "Utilisateurs",
            "PricingLocalized": "<span class=\"amount\">+<span class=\"amount-value\">12.00</span>&nbsp;<span class=\"currency-value\">€</span></span>/unité&nbsp;supp.",
            "TypeFeature": "Limitation",
            "QuantityIncluded": 2,
            "QuantityCurrent": 0
        },
        {
            "Id": 49,
            "ReferenceFeature": "feat-module-b",
            "IsVisible": true,
            "Properties": "None",
            "TitleLocalized": "Module B",
            "DescriptionLocalized": "Ce module est simplement fabuleux. Il vous facilitera grandement la vie.",
            "PricingLocalized": "en&nbsp;option <span class=\"amount\">+<span class=\"amount-value\">25.00</span>&nbsp;<span class=\"currency-value\">€</span></span>",
            "TypeFeature": "OnOff",
            "IsIncluded": false,
            "IsEnabled": false
        },
        {
            "Id": 243,
            "ReferenceFeature": "feat-agent",
            "IsVisible": true,
            "Properties": "None",
            "TitleLocalized": "Agents",
            "PricingLocalized": "<span class=\"amount\">+<span class=\"amount-value\">10.00</span>&nbsp;<span class=\"currency-value\">€</span></span>/unité&nbsp;supp.",
            "TypeFeature": "Limitation",
            "QuantityIncluded": 5,
            "QuantityCurrent": 5
        }
    ],
    "DateUpdate": "2025-03-25T17:45:43.28Z",
    "Links": [
        {
            "rel": "self",
            "href": "/v1/Subscription/430258"
        },
        {
            "rel": "insite-home",
            "href": "https://demo-eur.proabono.com/portal-auth/{Unique-Encrypted-URL1}"
        },          
        {
            "rel": "insite-related-subscription",
            "query": "{Unique-Encrypted-Query-Parameter1}"
        },
        {
            "rel": "insite-upgrade",
            "query": "{Unique-Encrypted-Query-Parameter2}"
        },
        {
            "rel": "related-quote",
            "href": "/v1/Pricing/Subscription/430258?ensureBillable=False"
        }
    ]
}
```

--------------------------------

### List Agents Example Request

Source: https://docs.proabono.com/api/backoffice-for-platform

An example GET request to list agents associated with a specific business ID.

```http
GET https://via.proabono.com/Organization/Agents/?IdBusiness=2
```

--------------------------------

### Example Request to Retrieve an InvoiceLine

Source: https://docs.proabono.com/api/backoffice

An example GET request to retrieve a specific InvoiceLine, including its ID and the Business ID.

```http
GET https://via.proabono.com/Finance/InvoiceLines/76?IdBusiness=42
```

--------------------------------

### Create Subscription with Overridden Upfront Amount

Source: https://docs.proabono.com/api

This example demonstrates creating a subscription with a specific upfront fee. The amount should be provided in the smallest currency unit (e.g., cents for EUR).

```json
{
    "ReferenceCustomer": "cust-42",
    "ReferenceOffer": "offer-premium-pro-plus",
    "AmountUpFront" : 10000
}
```

--------------------------------

### Example Request to Retrieve Invoice

Source: https://docs.proabono.com/api/backoffice

An example GET request to retrieve a specific invoice using its ID and business ID.

```http
GET https://via.proabono.com/Finance/Invoices/3281497?IdBusiness=42
```

--------------------------------

### Example Response for Offers

Source: https://docs.proabono.com/api

A sample JSON response detailing a paginated list of offers, including their IDs, pricing, visibility, and associated links for home or upgrade actions.

```JSON
{
  "Page": 1,
  "SizePage": 10,
  "Count": 2,
  "TotalItems": 2,
  "DateGenerated": "2025-03-30T13:09:08.72Z",
  "Items": [
    {
      "Id": 147,
      "ReferenceOffer": "offer-premium-pro-plus",
      "IsVisible": true,
      "TitleLocalized": "Premium Pro+",
      "PricingLocalized": "Euro 250.00/month(s) ",
      "Currency": "EUR",
      "AmountRecurrence": 25000,
      "DurationRecurrence": 1,
      "UnitRecurrence": "Month",
      "Links": [
        {
          "rel": "insite-home",
          "href": "https://demo-eur.proabono.com/portal-auth/{Unique-Encrypted-URL}"
        },
        {
          "rel": "insite-upgrade",
          "query": "{Unique-Encrypted-Query-Parameter1}"
        }
      ]
    },
    {
      "Id": 35,
      "ReferenceOffer": "offer-premium",
      "IsVisible": true,
      "TitleLocalized": "Premium",
      "PricingLocalized": "Euro 190.00/month(s) ",
      "Currency": "EUR",
      "AmountRecurrence": 19000,
      "DurationRecurrence": 1,
      "UnitRecurrence": "Month",
      "Links": [
        {
          "rel": "insite-home",
          "href": "https://demo-eur.proabono.com/portal-auth/{Unique-Encrypted-URL}"
        },
        {
          "rel": "insite-related-subscription",
          "query": "{Unique-Encrypted-Query-Parameter2}"
        }
      ]
    }
  ]
}
```

--------------------------------

### Compute Offer Pricing Example Response 2 - Offer with paying features

Source: https://docs.proabono.com/api/backoffice

Example response for an offer that includes paying features, detailing initial fees and recurring subscription costs with taxes.

```json
{
    "DateGeneration": "2025-09-11T14:00:35.52Z",
    "AmountSubtotal": 17200,
    "AmountTotalDue": 20209,
    "Details": [
        {
            "TypeMove": "SubscriptionInitialFee",
            "Label": "Up-front amount",
            "AmountSubtotal": 4900,
            "AmountTotalDue": 5757,
            "Tax1": {
                "IdTaxProfile": 252,
                "Label": "Tax1",
                "Rate": 1000,
                "Amount": 490,
                "Type": "Standard"
            },
            "Tax2": {
                "IdTaxProfile": 253,
                "Label": "Tax2",
                "Rate": 750,
                "Amount": 367,
                "Type": "Standard"
            }
        },
        {
            "TypeMove": "SubscriptionRecurringAmount",
            "Label": "Subscription amount",
            "AmountSubtotal": 9900,
            "AmountTotalDue": 11632,
            "Tax1": {
                "IdTaxProfile": 252,
                "Label": "Tax1",
                "Rate": 1000,
                "Amount": 990,
                "Type": "Standard"
            },
            "Tax2": {
                "IdTaxProfile": 253,
                "Label": "Tax2",
                "Rate": 750,
                "Amount": 742,
                "Type": "Standard"
            }
        },
        {
            "IdFeature": 239,
            "TypeMove": "SubscriptionFeatures",
            "Label": "Module A",
            "AmountSubtotal": 1000,
            "AmountTotalDue": 1175,
            "Tax1": {
                "IdTaxProfile": 252,
                "Label": "Tax1",
                "Rate": 1000,
                "Amount": 100,
                "Type": "Standard"
            },
            "Tax2": {
                "IdTaxProfile": 253,
                "Label": "Tax2",
                "Rate": 750,
                "Amount": 75,
                "Type": "Standard"
            }
        },
        {
            "IdFeature": 238,
            "TypeMove": "SubscriptionFeatures",
            "Label": "Users",
            "AmountSubtotal": 1400,
            "AmountTotalDue": 1645,
            "QuantityReal": 3,
            "QuantityBilled": 3,
            "Tax1": {
                "IdTaxProfile": 252,
                "Label": "Tax1",
                "Rate": 1000,
                "Amount": 140,
                "Type": "Standard"
            },
            "Tax2": {
                "IdTaxProfile": 253,
                "Label": "Tax2",
                "Rate": 750,
                "Amount": 105,
                "Type": "Standard"
            }
        }
    ]
}
```

--------------------------------

### List Offers Example Response

Source: https://docs.proabono.com/api/backoffice

A sample JSON response for the List Offers endpoint, showing paginated offer data.

```json
{
    "Page": 1,
    "SizePage": 3,
    "Count": 3,
    "TotalItems": 15,
    "DateGenerated": "2025-04-27T13:54:26.72Z",
    "Items": [
        {
            "Id": 2836,
            "IdSegment": 69,
            "DateUpdate": "2025-04-27T13:54:01.27Z",
            "IdUserUpdate": 69719,
            "DateCreation": "2025-04-27T13:54:01.27Z",
            "IdUserCreation": 69719,
            "StateLife": "Ok",
            "ReferenceOffer": "premium",
            "Name": "Premium",
            "Order": 2,
            "IsVisible": true,
            "AmountUpFront": 1990,
            "AmountRecurrence": 890,
            "DurationRecurrence": 3,
            "UnitRecurrence": "Month",
            "Links": [
                {
                    "rel": "self",
                    "href": "/Sub/Offers/2836"
                }
            ]
        },
        {
            "Id": 2835,
            "IdSegment": 69,
            "DateUpdate": "2025-04-27T13:53:06.17Z",
            "IdUserUpdate": 69719,
            "DateCreation": "2025-04-27T13:53:06.17Z",
            "IdUserCreation": 69719,
            "StateLife": "Ok",
            "ReferenceOffer": "premium-pro",
            "Name": "Premium Pro",
            "Order": 3,
            "IsVisible": true,
            "AmountUpFront": 990,
            "AmountRecurrence": 199,
            "DurationRecurrence": 1,
            "UnitRecurrence": "Month",
            "Links": [
                {
                    "rel": "self",
                    "href": "/Sub/Offers/2835"
                }
            ]
        },
        {
            "Id": 2834,
            "IdSegment": 69,
            "DateUpdate": "2025-04-27T13:51:58.67Z",
            "IdUserUpdate": 69719,
            "DateCreation": "2025-04-27T13:51:58.67Z",
            "IdUserCreation": 69719,
            "StateLife": "Ok",
            "ReferenceOffer": "starter",
            "Name": "Starter",
            "Order": 1,
            "IsVisible": true,
            "DurationTrial": 10,
            "UnitTrial": "Day",
            "AmountRecurrence": 49,
            "DurationRecurrence": 1,
            "UnitRecurrence": "Month",
            "Links": [
                {
                    "rel": "self",
                    "href": "/Sub/Offers/2834"
                }
            ]
        }
    ],
    "Links": [
        {
            "rel": "next",
            "href": "/Sub/Offers/?SizePage=3&page=2"
        }
    ]
}
```

--------------------------------

### Example Response for Usage Update

Source: https://docs.proabono.com/api

This is an example response for a usage update request, showing subscription details, pricing, and detailed breakdown.

```JSON
{
    "IdSubscription": 44082,
    "AmountTotalDue": 5038,
    "PricingLocalized": "&euro; 50.38",
    "DatePeriodStart": "2025-08-09T15:58:20.73Z",
    "DatePeriodEnd": "2025-08-23T12:38:55.00Z",
    "AmountSubtotal": 3952,
    "AmountTotal": 5038,
    "Details": [
        {
            "IdSubscription": 44082,
            "IdFeature": 48,
            "LabelLocalized": "Feature - prorated adjustment - Active Users",
            "AmountTotalDue": 5038,
            "DatePeriodStart": "2025-08-09T15:58:20.73Z",
            "DatePeriodEnd": "2025-08-23T12:38:55.00Z",
            "QuantityReported": 6,
            "QuantityBilled": 4,
            "AmountSubtotal": 3952,
            "AmountTotal": 5038
        }
    ]
}
```

```JSON
{
    "IdSubscription": 44082,
    "AmountTotalDue": 5038,
    "PricingLocalized": "&euro; 50.38",
    "DatePeriodStart": "2025-08-09T15:58:20.73Z",
    "DatePeriodEnd": "2025-08-23T12:38:55.00Z",
    "AmountSubtotal": 3952,
    "AmountTotal": 5038,
    "Details": [
        {
            "IdSubscription": 44082,
            "IdFeature": 48,
            "LabelLocalized": "Feature - prorated adjustment - Active Users",
            "AmountTotalDue": 5038,
            "DatePeriodStart": "2025-08-09T15:58:20.73Z",
            "DatePeriodEnd": "2025-08-23T12:38:55.00Z",
            "QuantityReported": 6,
            "QuantityBilled": 4,
            "AmountSubtotal": 3952,
            "AmountTotal": 5038
        }
    ],
    "NextTerm": {
        "IdSubscription": 44082,
        "LabelLocalized": "Subscription cost after modification",       
        "PricingLocalized": "&euro; 191.22",
        "DatePeriodStart": "2025-08-23T12:38:55.00Z",   
        "DatePeriodEnd": "2025-09-23T12:38:55.00Z",
        "AmountSubtotal": 15000,
        "AmountTotal": 19122,
        "Details": [
            {
                "IdSubscription": 44082,
                "LabelLocalized": "Flat fee",
                "AmountTotalDue": 6374,
                "DatePeriodStart": "2025-08-23T12:38:55.00Z",
                "DatePeriodEnd": "2025-09-23T12:38:55.00Z",
                "AmountSubtotal": 5000,
                "AmountTotal": 6374
            },      
            {
                "IdSubscription": 44082,
                "IdFeature": 48,
                "LabelLocalized": "Feature - Active Users",
                "AmountTotalDue": 12748,
                "DatePeriodStart": "2025-08-23T12:38:55.00Z",
                "DatePeriodEnd": "2025-09-23T12:38:55.00Z",
                "QuantityReported": 6,
                "QuantityBilled": 4,
                "AmountSubtotal": 10000,
                "AmountTotal": 12748
            }
        ]
    }   
}
```
Tokens:
Raw