Customer Invoicing

Customer Invoices
Estimates
Billing Subscriptions

Referentials

Customers
Products
Categories
Plan Items
- List all plan itemsget
- Create a plan itempost
Enums
- Retrieve an enumget
Suppliers
CategoryGroups
- List all category groupsget

Supplier Invoicing

Supplier Invoices

Others

Connection test
- User Profileget

Customer Invoicing

Customer Invoices
Estimates
Billing Subscriptions

Referentials

Customers
Products
Categories
Plan Items
- List all plan itemsget
- Create a plan itempost
Enums
- Retrieve an enumget
Suppliers
CategoryGroups
- List all category groupsget

Supplier Invoicing

Supplier Invoices

Others

Connection test
- User Profileget

List all Billing Subscriptions

get https://app.pennylane.com/api/external/v1/billing_subscriptions

This endpoint returns a list of subscriptions.

URL Expired

The URL for this request expired after 30 days.

Query Params

page

integer

Invoices are paginated, this is the current page which will be returned. The page index is starting at 1.

filter

string

You can choose to filter billing_subscriptions on a specific attributes (status, customer_id, start, etc).

Please refer to the filters page to learn how to correctly build the filter parameter.

For instance, you can select the invoices that have the status draft by using the following filter: [{"field": "status", "operator": "scope", "value": "draft"}].

Responses

Response body

object

totalPages

integer

The total number of pages available

currentPage

integer

The current page returned

billing_subscriptions

array of objects

List of billing subscriptions

billing_subscriptions

object

number

next_occurrence

string

prev_occurrence

string | null

stopped_at

date-time | null

start

date

finish

string

status

string

mode

string

email_settings

object

activated_at

date-time | null

payment_method

string

recurring_rule

object

customer

object

invoice_template

object

v2_id

integer

The corresponding identifier for this resource in the V2 API.
This field is provided to facilitate migration from V1 to V2 API by allowing mapping
between V1 and V2 identifiers. When transitioning to V2 endpoints, use this value
instead of the V1 id or source_id.

Response body

object

error

string

required

Response body

object

Updated over 1 year ago

Update an estimate status

Create a Billing Subscription

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.pennylane.com/api/external/v1/billing_subscriptions \
3
     --header 'accept: application/json'


xxxxxxxxxx
115
}
1
{
2
  "totalPages": 5,
3
  "currentPage": 1,
4
  "billing_subscriptions": [
5
    {
6
      "id": 0,
7
      "next_occurrence": "string",
8
      "prev_occurrence": "string",
9
      "stopped_at": "2023-08-30T10:08:08.146343Z",
10
      "start": "2023-01-01",
11
      "finish": "2023-12-31",
12
      "status": "string",
13
      "mode": "string",
14
      "email_settings": {},
15
      "activated_at": "2023-08-30T10:08:08.146343Z",
16
      "payment_method": "string",
17
      "recurring_rule": {
18
        "day_of_month": [
19
          0
20
        ],
21
        "week_start": 0,
22
        "day": [
23
          0
24
        ],
25
        "rule_type": "weekly",

Updated over 1 year ago

Update an estimate status

Create a Billing Subscription

Customer Invoicing
Customer Invoices
Update plan items numberspost
Finalize an invoiceput
Mark the invoice as paid. No accounting entries created.put
Send an invoice or an estimate by emailpost
Links an invoice with a credit notepost
Edit Invoice Linesput
Update an invoiceput
Retrieve an invoiceget
List all invoicesget
Create an invoicepost
Import an invoicepost
Estimates
Update an estimate statusput
Retrieve an estimateget
Create an estimatepost
List all estimatesget
Billing Subscriptions
Update a Billing Subscriptionput
Retrieve a Billing Subscriptionget
Create a Billing Subscriptionpost
List all Billing Subscriptionsget

Referentials
Customers
Send a mandate request emailpost
Update a customerput
Retrieve a customerget
List all customersget
Create a customerpost
Products
Update a productput
Retrieve a productget
List all productsget
Create a productpost
Categories
Update a categoryput
Retrieve a categoryget
Create a new categorypost
List all categoriesget
Plan Items
Create a plan itempost
List all plan itemsget
Enums
Retrieve an enumget
Suppliers
Update a supplierput
Retrieve a supplierget
Create a supplierpost
List all suppliersget
CategoryGroups
List all category groupsget

Supplier Invoicing
Supplier Invoices
Import a supplier invoicepost
Update a supplier invoiceput
Retrieve a supplier invoiceget
List all invoicesget

Others
Connection test
User Profileget

Customer Invoicing
Customer Invoices
Update plan items numberspost
Finalize an invoiceput
Mark the invoice as paid. No accounting entries created.put
Send an invoice or an estimate by emailpost
Links an invoice with a credit notepost
Edit Invoice Linesput
Update an invoiceput
Retrieve an invoiceget
List all invoicesget
Create an invoicepost
Import an invoicepost
Estimates
Update an estimate statusput
Retrieve an estimateget
Create an estimatepost
List all estimatesget
Billing Subscriptions
Update a Billing Subscriptionput
Retrieve a Billing Subscriptionget
Create a Billing Subscriptionpost
List all Billing Subscriptionsget

Referentials
Customers
Send a mandate request emailpost
Update a customerput
Retrieve a customerget
List all customersget
Create a customerpost
Products
Update a productput
Retrieve a productget
List all productsget
Create a productpost
Categories
Update a categoryput
Retrieve a categoryget
Create a new categorypost
List all categoriesget
Plan Items
Create a plan itempost
List all plan itemsget
Enums
Retrieve an enumget
Suppliers
Update a supplierput
Retrieve a supplierget
Create a supplierpost
List all suppliersget
CategoryGroups
List all category groupsget

Supplier Invoicing
Supplier Invoices
Import a supplier invoicepost
Update a supplier invoiceput
Retrieve a supplier invoiceget
List all invoicesget

Others
Connection test
User Profileget

200Get all the billing subscriptions

401Access token is missing or invalid

403Forbidden