---
title: "Create a billing subscription"
method: POST
path: "/api/external/v2/billing_subscriptions"
tags: ["Billing Subscriptions"]
---

# Create a billing subscription

`POST /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`

## Request body

- object
  - `start` string, date, required
  - `mode` union, required
    - object — Use this mode if you need generated invoices to be sent by email.
      - `type` 'email', required — - `email`: generated invoices will be finalized and sent by email to the recipients configured on the subscription
      - `email_settings` object, required — Email settings for sending invoices. The total number of email addresses must not exceed 25. An email template with both a subject and body content must be configured in the company settings. A GoCardless subscription requires a dedicated GoCardless email template configured in the company settings.
        - `recipients` string[] — Primary email recipients for invoice delivery. If not provided, the recipients configured on the customer will be used instead.
    - object
      - `type` 'awaiting_validation' | 'finalized', required — - `awaiting_validation`: generated invoices will be in draft - `finalized`: generated invoices will be finalized
  - `payment_conditions` 'upon_receipt' | '7_days' | '15_days' | '30_days' | '30_days_end_of_month' | '45_days' | '45_days_end_of_month' | '60_days', required
  - `payment_method` 'offline' | 'gocardless_direct_debit' | 'pro_account_sepa_core', 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.
  - `label` string, nullable
  - `recurring_rule` union, required
    - object
      - `type` 'yearly', required
      - `interval` integer — Interval between each occurrence in years.
      - `count` integer — Number of occurrences
    - object
      - `type` 'monthly', required
      - `interval` integer — Interval between each occurrence in months.
      - `count` integer — Number of occurrences
      - `day_of_month` number
    - object
      - `type` 'weekly', required
      - `interval` integer — Interval between each occurrence in weeks.
      - `count` integer — Number of occurrences
      - `day_of_week` 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday'
  - `customer_id` integer, required — Customer identifier
  - `customer_invoice_data` object, required
    - `currency` 'EUR' | 'USD' | 'GBP' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWL'
    - `customer_invoice_template_id` integer — The customer invoice template ID
    - `pdf_invoice_free_text` string, nullable — For example, the contact details of the person to contact
    - `pdf_invoice_subject` string, nullable — Invoice title
    - `pdf_description` string, nullable — Invoice description
    - `special_mention` string, nullable — Additional details
    - `language` 'fr_FR' | 'en_GB' | 'de_DE' — The local default is based on the thirdparty (customer / supplier ) billing_language . In case the customer is not present, we will default to the company locale.
    - `discount` object
      - `type` 'absolute' | 'relative', required — Discount type. - absolute if it is an amount - relative if it is a percentage
      - `value` string, required — Discount value on the total amount before tax
    - `invoice_line_sections` object[]
      - `title` string — Title of the invoice line section
      - `description` string — Description of the invoice line section
      - `rank` integer, required — Defines the order in which sections will be displayed on the invoice. Each section has to have a different rank, starting from 1 and incrementing next values by 1
    - `invoice_lines` object[], required
      - `label` string, required — Line item label
      - `quantity` number, required — Line item quantity (number of items)
      - `unit` string, required — Line item unit (type of unit)
      - `raw_currency_unit_price` string, required — The unit price excluding taxes (undiscounted if a discount is set). Can be set up to 6 decimals.
      - `vat_rate` 'FR_1_05' | 'FR_1_75' | 'FR_09' | 'FR_21' | 'FR_40' | 'FR_50' | 'FR_55' | 'FR_60' | 'FR_65' | 'FR_85' | 'FR_92' | 'FR_100' | 'FR_130' | 'FR_15_385' | 'FR_160' | 'FR_196' | 'FR_200' | 'AD_10' | 'AD_45' | 'AD_95' | 'AT_100' | 'AT_130' | 'AT_190' | 'AT_200' | 'BE_60' | 'BE_120' | 'BE_210' | 'BG_90' | 'BG_200' | 'CH_25' | 'CH_37' | 'CH_77' | 'CH_26' | 'CH_38' | 'CH_81' | 'CY_30' | 'CY_50' | 'CY_80' | 'CY_90' | 'CY_190' | 'CZ_100' | 'CZ_120' | 'CZ_150' | 'CZ_210' | 'DE_70' | 'DE_190' | 'DK_250' | 'EE_90' | 'EE_200' | 'EE_220' | 'EE_240' | 'ES_40' | 'ES_70' | 'ES_100' | 'ES_210' | 'FI_100' | 'FI_135' | 'FI_140' | 'FI_240' | 'FI_255' | 'GB_50' | 'GB_200' | 'GR_60' | 'GR_130' | 'GR_170' | 'GR_240' | 'GR_40' | 'HR_50' | 'HR_130' | 'HR_250' | 'HU_50' | 'HU_180' | 'HU_270' | 'IE_48' | 'IE_90' | 'IE_135' | 'IE_210' | 'IE_230' | 'IT_40' | 'IT_50' | 'IT_100' | 'IT_220' | 'LT_50' | 'LT_90' | 'LT_120' | 'LT_210' | 'LU_30' | 'LU_70' | 'LU_80' | 'LU_120' | 'LU_130' | 'LU_140' | 'LU_160' | 'LU_170' | 'LV_50' | 'LV_120' | 'LV_210' | 'MC_09' | 'MC_21' | 'MC_55' | 'MC_85' | 'MC_100' | 'MC_200' | 'MT_50' | 'MT_70' | 'MT_120' | 'MT_180' | 'MU_150' | 'NL_90' | 'NL_210' | 'PL_50' | 'PL_80' | 'PL_230' | 'PT_60' | 'PT_130' | 'PT_160' | 'PT_180' | 'PT_220' | 'PT_230' | 'RO_50' | 'RO_90' | 'RO_110' | 'RO_190' | 'RO_210' | 'SE_60' | 'SE_120' | 'SE_250' | 'SI_50' | 'SI_95' | 'SI_220' | 'SK_50' | 'SK_100' | 'SK_190' | 'SK_200' | 'SK_230' | 'NO_120' | 'NO_150' | 'NO_250' | 'DE_70_BU0002' | 'DE_190_BU0003' | 'DE_70_BU0008' | 'DE_190_BU0009' | 'DE_intracom_70_BU0012' | 'DE_intracom_190_BU0013' | 'DE_190_electronic_BU0226' | 'exempt' | 'DE_intracom_exempt_BU0011' | 'DE_intracom_exempt_BU0047' | 'DE_exempt_BU0001' | 'DE_exempt_BU0181' | 'DE_exempt_BU0490' | 'intracom_21' | 'intracom_55' | 'intracom_85' | 'intracom_100' | 'crossborder' | 'DE_intracom_70_BU0018' | 'DE_intracom_190_BU0019' | 'DE_intracom_190_BU0506' | 'extracom' | 'DE_extracom_BU0173' | 'DE_extracom_BU0191' | 'DE_extracom_190_BU0511' | 'FR_85_construction' | 'FR_100_construction' | 'FR_200_construction' | 'DE_exempt_construction_BU0046' | 'DE_70_construction_BU0091' | 'DE_190_construction_BU0094' | 'DE_190_construction_BU0526' | 'DE_190_construction_BU0546' | 'mixed', required — Product VAT rate. A 20% VAT in France is FR_200.
      - `description` string, nullable — The description of the invoice line
      - `section_rank` integer — Has to correspond to the rank number of a line items section in which the line item should be
      - `discount` object
        - `type` 'absolute' | 'relative', required — Discount type. - absolute if it is an amount - relative if it is a percentage
        - `value` string, required — Discount value on the total amount before tax of the line
      - `ledger_account_id` integer — The ledger account ID
      - `product_id` integer — The product ID

## Response `201`

Renders the created billing subscription

- object
  - `id` integer, required — Billing subscription identifier
  - `next_occurrence` string, date, nullable, required — The date for the next subscription renewal
  - `prev_occurrence` string, date, nullable, required — The date of the previous subscription renewal
  - `stopped_at` string, date-time, nullable, required — The exact timestamp when the subscription was terminated
  - `start` string, date, nullable, required — The subscription start date
  - `finish` string, date, nullable, required — The date of the last occurrence of the subscription
  - `status` 'draft' | 'stopped' | 'finished' | 'pending' | 'not_started' | 'in_progress', required
  - `mode` 'awaiting_validation' | 'finalized' | 'email', required — - `awaiting_validation`: generated invoices will be in draft - `finalized`: generated invoices will be finalized - `email`: generated invoices will be finalized and sent by email to the recipients configured on the subscription
  - `activated_at` string, date-time, nullable, required — The exact timestamp for when the subscription was activated
  - `payment_conditions` union, required
    - 'upon_receipt' | '7_days' | '15_days' | '30_days' | '30_days_end_of_month' | '45_days' | '45_days_end_of_month' | '60_days'
    - unknown
  - `payment_method` 'offline' | 'gocardless_direct_debit' | 'pro_account_sepa_core', 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.
  - `label` string, nullable, required
  - `email_settings` object, nullable, required
    - `recipients` string[], required — Primary email recipients for invoice delivery
    - `billing_email_template` object, nullable, required
      - `id` integer, required
      - `label` string, required
  - `recurring_rule` object, required
    - `day_of_month` number[], nullable, required
    - `month_of_year` number[], nullable, required
    - `week_start` number, nullable, required
    - `day` number[], nullable, required
    - `rule_type` 'weekly' | 'monthly' | 'yearly', required
    - `interval` integer, nullable, required
    - `count` integer, nullable, required — Number of occurrences of the recurring rule
    - `until` string, nullable, required
  - `customer` object, nullable, required
    - `id` integer, required
    - `url` string, required — URL to get the customer.
  - `customer_invoice_data` object, required
    - `label` string, nullable, required — Invoice label
    - `currency` 'EUR' | 'USD' | 'GBP' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'FJD' | 'FKP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SLE' | 'SOS' | 'SRD' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZWL', required
    - `amount` string, required — Invoice amount (total value of the invoice in euros. If the currency is euro, `currency_amount` and `amount` are identical)
    - `currency_amount` string, required — Invoice currency amount (total value of the invoice in the currency of the invoice)
    - `currency_amount_before_tax` string, required — Invoice currency amount before tax (total value before tax of the invoice in the currency of the invoice)
    - `exchange_rate` string, required — Invoice exchange rate (used to convert the invoice to euros. If the invoice currency is euro it will be 1.0)
    - `currency_tax` string, required — Invoice taxable amount (in euros. If the currency is euro, `currency_amount` and `amount` are identical)
    - `language` 'fr_FR' | 'en_GB' | 'de_DE', required — The local default is based on the thirdparty (customer / supplier ) billing_language . In case the customer is not present, we will default to the company locale.
    - `customer_invoice_template` object, nullable, required
      - `id` integer, required
    - `discount` object, required
      - `type` 'absolute' | 'relative', required — Discount type. - absolute if it is an amount - relative if it is a percentage
      - `value` string, nullable, required — Discount value on the total amount before tax
    - `pdf_invoice_free_text` string, required
    - `pdf_invoice_subject` string, required
    - `pdf_description` string, nullable, required
    - `special_mention` string, nullable, required — Additional details
    - `invoice_line_sections` object, required
      - `url` string, required — URL to get the invoice line sections of the invoice.
    - `invoice_lines` object, required
      - `url` string, required — URL to get the invoice lines of the invoice.
  - `created_at` string, date-time, required — The time the subscription has been created
  - `updated_at` string, date-time, required — The last time the subscription has been updated

## Other responses

- `400` — Bad request
- `401` — Access token is missing or invalid
- `403` — Access to this resource forbidden
- `404` — The resource was not found
- `422` — Unprocessable content

---

[API](https://skmtc.net/pennylane/apis/company-v2.md) · [All operations](https://skmtc.net/pennylane/apis/company-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pennylane/company-v2/versions/a5b7236473c6/schema)