Sign in
Billing Schedules

Duplicate a billing schedule

Duplicate a billing schedule onto the customer named in the request. The copy is always created as a draft, and is given its own prices, phases and credit grants rather than sharing the source's.

Attachments and custom field values belong to the customer rather than to the schedule. Duplicating for the same customer carries both across, the attachments referencing the same assets so that nothing is re-uploaded. Duplicating for a different customer attaches nothing, and carries the custom field keys with blank values.

post/billing-schedules/{billingScheduleId}/duplicate

Path parameters

billingScheduleIdstring required

Billing Schedule ID

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

customerIdstring required

Customer ID

Example request

{
  "customerId": "cca32597-b6b0-4499-9669-128aef8702e4"
}

Response

Created

idstring required

Billing Schedule ID

customerIdstring required

Customer ID

status'DRAFT' | 'PENDING' | 'ACTIVE' | 'SUSPENDED' | 'CANCELLED' | 'COMPLETED' required
startDatestring required

Start date

endDatestring

End date

firstBillingDatestring

First billing date

autoIssueInvoicesboolean required

If true, invoices will be automatically sent for this billing schedule

purchaseOrderNumberstring

Optional purchase order number to be added to invoices

referencestring

Optional reference to be added to invoices

labelstring

Optional label

recurrenceDayOfMonthinteger

The day of the month on which billing recurs

createdAtstring required

Time at which the schedule was initially created, in ISO 8601 format.

updatedAtstring required

Time at which the schedule was last updated, in ISO 8601 format.

lastInvoiceIdstring

ID of the last invoice (if there has been one)

archivedAtstring

Time at which the schedule was archived, in ISO 8601 format.

rollUpBillingboolean required

Roll up billing

contractIdstring

Optional ID of the contract used to create this billing schedule

defaultDueDateDaysinteger

Default number of days between invoice issue date and due date

memostring

Billing schedule memo

customFieldsobject required

Custom key-value fields for this billing schedule

paymentProvider'STRIPE' | 'GOCARDLESS' | 'NONE'
autoChargeboolean

Whether invoices for this billing schedule are automatically charged

Example response

{
  "id": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
  "customerId": "cca32597-b6b0-4499-9669-128aef8702e4",
  "status": "ACTIVE",
  "startDate": "2022-01-01",
  "endDate": "2022-12-01",
  "taxRates": [
    {
      "priceId": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
      "taxRateId": "50c0d53b-8460-41e6-b4e9-a4e157fc1a64"
    }
  ],
  "firstBillingDate": "2022-02-02",
  "autoIssueInvoices": false,
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "label": "label",
  "recurrenceDayOfMonth": 1,
  "prices": [
    {
      "id": "bc61d4b8-e9d6-4f4a-9bcf-f5dae874c730",
      "productId": "f409d651-c475-4142-aafd-a5d2bd74d4f9",
      "name": "Demo Product",
      "currency": "GBP",
      "structure": {
        "pricePerUnit": "0.25",
        "usageMetricId": "04c62961-04ba-48e6-b985-758bb7d3e712",
        "isPricePercentage": false,
        "pricingType": "LINEAR"
      },
      "billingFrequency": "MONTHLY",
      "billingType": "IN_ARREARS",
      "createdAt": "2022-06-28T16:47:00Z",
      "updatedAt": "2022-06-28T16:47:00Z",
      "integrationIds": [
        {
          "service": "Xero",
          "id": "123",
          "isPending": false
        }
      ],
      "customMetricParameters": [
        {
          "parameterId": "94703530-1293-479b-bd37-ccad42fd9c8b",
          "value": "10"
        }
      ],
      "listPriceId": "b4d7e884-e007-4183-8355-4771865c5100",
      "usageCalculationPeriod": {
        "frequency": "MONTHLY",
        "interval": 1
      },
      "status": "ACTIVE"
    }
  ],
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "lastInvoiceId": "bdbf78a5-b007-4d46-aa7d-d0417a649d64",
  "phases": [
    {
      "id": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
      "name": "Onboarding",
      "externalContractRef": "ACME-2022-MSA",
      "createdAt": "2022-06-28T16:47:00Z",
      "billingScheduleId": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
      "priceIds": [
        "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
      ],
      "startDate": "2022-01-01",
      "endDate": "2022-06-30",
      "discounts": [
        {
          "id": "4451f62c-0c1f-491c-aeb2-9eb41b28149c",
          "restrictToPrices": [
            "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
          ],
          "type": "PERCENTAGE",
          "amount": 15,
          "message": "15% Discount",
          "separateLineItem": true,
          "seatDiscountType": "ALL_SEATS"
        }
      ],
      "minimums": [
        {
          "id": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
          "billingScheduleId": "b102e007-f5d7-4b1a-8a1d-9a51135ae73b",
          "phaseId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "amount": 100,
          "restrictToPrices": [
            "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8"
          ],
          "createdAt": "2022-06-28T16:47:00Z",
          "updatedAt": "2022-06-28T16:47:00Z"
        }
      ],
      "creditGrants": [
        {
          "id": "0199ca8a-e7e8-73b3-bd69-a316a23231a0",
          "name": "Monthly usage credits",
          "creditUnitType": "CURRENCY",
          "currency": "GBP",
          "amount": 100,
          "costOfCredit": 0,
          "taxRateId": "179d1ab3-cc96-48e2-9310-067b0b42d47c",
          "grantRefreshFrequency": "MONTHLY",
          "billingFrequency": "MONTHLY",
          "rolloverMode": "NONE",
          "restrictToPrices": [
            "0199ca89-2d9e-7e3d-914c-7de86e8fc7ce"
          ]
        }
      ],
      "integrationIds": [
        {
          "service": "NetSuite",
          "id": "SO-1024",
          "lastSynced": "2022-06-28T16:47:00Z",
          "url": "https://system.netsuite.com/app/accounting/transactions/salesord.nl?id=1024",
          "isPending": false
        }
      ],
      "recurrencePreference": "CONTINUE_FROM_PREVIOUS_PHASE",
      "phasePriceMetadata": [
        {
          "priceId": "6dc54805-0ac8-4f17-9341-4d3f2db9dcd8",
          "arrCalculation": "INCLUDE"
        }
      ]
    }
  ],
  "archivedAt": "2022-06-28T16:47:00Z",
  "rollUpBilling": false,
  "integrationIds": [
    {
      "service": "Salesforce",
      "id": "a0CQy00000Ipz5VMAR",
      "lastSynced": "2024-08-14T17:14:17Z",
      "url": "https://sequence-b-dev-ed.develop.my.salesforce.com/lightning/r/sequence__Billing_Schedule__c/a0CQy00000Ipz5VMAR/view",
      "isPending": false
    }
  ],
  "attachmentAssets": [
    {
      "id": "e007e884-5100-4183-8355-4771865cb4dd",
      "createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "type": "IMAGE",
      "format": "PNG",
      "fileName": "my-image.png",
      "fileSizeBytes": 12345,
      "url": "https://assets.sequencehq.com/018f9ad5-4192-76d7-aea5-d80a9018eded/images/e007e884-5100-4183-8355-4771865cb4dd.png",
      "createdAt": "2022-06-28T16:47:00Z"
    }
  ],
  "contractId": "0194d091-f65b-7b98-b75f-a923aa0f5b1a",
  "defaultDueDateDays": 30,
  "memo": "Example Billing Schedule",
  "customFields": {
    "key": "value"
  },
  "paymentProvider": "STRIPE",
  "autoCharge": true
}

Changes