API Reference

Create a billing subscription

post
https://app.pennylane.com/api/external/v2/billing_subscriptions

This endpoint allows you to create a subscription. Pennylane will generate the customer invoice each month.
You can also link the subscription to a GoCardless mandate.

ℹ️

This endpoint requires the following scope: billing_subscriptions:all

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
date
required
mode
object
required
string
enum
required
string
enum
required

Payment method
offline means the subscription is not linked to a payment method
gocardless_direct-debit means at each new occurrence the client will be automatically debited thanks to GoCardless. To do so, you need a GoCardless account properly configured.

Allowed:
string | null
recurring_rule
object
required
int64
required

Customer identifier

customer_invoice_data
object
required
Headers
string

Numeric ID of the company to act on. Required when authenticating with a firm token. Ignored when the token is already bound to a company.

Responses

Updated 5 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago