v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB

Billing

Create a new billing profile

Billing profiles are representations of a customer's billing information. Customer overrides can be applied to a billing profile to customize the billing behavior for a specific customer.

post/api/v1/billing/profiles

Request body

namestring required

Human-readable name for the resource. Between 1 and 256 characters.

descriptionstring

Optional description of the resource. Maximum 1024 characters.

metadataMetadata

Set of key-value pairs. Metadata can be used to store additional information about a resource.

defaultboolean required

Is this the default profile?

Example request

{
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "supplier": {
    "addresses": [
      {
        "country": "US"
      }
    ]
  },
  "workflow": {
    "collection": {
      "alignment": {
        "recurringPeriod": {
          "anchor": "2023-01-01T01:01:01.001Z"
        }
      },
      "interval": "P1D"
    },
    "invoicing": {
      "draftPeriod": "P1D",
      "dueAfter": "P30D",
      "defaultTaxConfig": {
        "stripe": {
          "code": "txcd_10000000"
        },
        "taxCodeId": "01G65Z755AFWAKHE12NY0CQ9FH"
      }
    }
  },
  "apps": {
    "tax": "01G65Z755AFWAKHE12NY0CQ9FH",
    "invoicing": "01G65Z755AFWAKHE12NY0CQ9FH",
    "payment": "01G65Z755AFWAKHE12NY0CQ9FH"
  }
}

Response

The request has succeeded and a new resource has been created as a result.

idstring required

A unique identifier for the resource.

namestring required

Human-readable name for the resource. Between 1 and 256 characters.

descriptionstring

Optional description of the resource. Maximum 1024 characters.

metadataMetadata

Set of key-value pairs. Metadata can be used to store additional information about a resource.

createdAtstring date-time required

Timestamp of when the resource was created.

updatedAtstring date-time required

Timestamp of when the resource was last updated.

deletedAtstring date-time

Timestamp of when the resource was permanently deleted.

defaultboolean required

Is this the default profile?

Example response

{
  "id": "01G65Z755AFWAKHE12NY0CQ9FH",
  "metadata": {
    "externalId": "019142cc-a016-796a-8113-1a942fecd26d"
  },
  "createdAt": "2024-01-01T01:01:01.001Z",
  "updatedAt": "2024-01-01T01:01:01.001Z",
  "deletedAt": "2024-01-01T01:01:01.001Z",
  "supplier": {
    "addresses": [
      {
        "country": "US"
      }
    ]
  },
  "workflow": {
    "collection": {
      "alignment": {
        "recurringPeriod": {
          "anchor": "2023-01-01T01:01:01.001Z"
        }
      },
      "interval": "P1D"
    },
    "invoicing": {
      "draftPeriod": "P1D",
      "dueAfter": "P30D",
      "defaultTaxConfig": {
        "stripe": {
          "code": "txcd_10000000"
        },
        "taxCodeId": "01G65Z755AFWAKHE12NY0CQ9FH"
      }
    }
  },
  "apps": {
    "tax": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "type": "stripe",
      "name": "Stripe",
      "status": "ready",
      "listing": {
        "type": "stripe",
        "name": "Stripe",
        "description": "Stripe integration allows you to collect payments with Stripe.",
        "capabilities": [
          {
            "type": "calculateTax",
            "key": "stripe_calculate_tax",
            "name": "Calculate Tax",
            "description": "Stripe Tax calculates tax portion of the invoices."
          },
          {
            "type": "invoiceCustomers",
            "key": "stripe_invoice_customers",
            "name": "Invoice Customers",
            "description": "Stripe invoices customers with due amount."
          },
          {
            "type": "collectPayments",
            "key": "stripe_collect_payments",
            "name": "Collect Payments",
            "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method."
          }
        ],
        "installMethods": [
          "with_oauth2",
          "with_api_key"
        ]
      },
      "createdAt": "2024-01-01T01:01:01.001Z",
      "updatedAt": "2024-01-01T01:01:01.001Z",
      "stripeAccountId": "acct_123456789",
      "livemode": true,
      "maskedAPIKey": "sk_live_************abc"
    },
    "invoicing": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "type": "stripe",
      "name": "Stripe",
      "status": "ready",
      "listing": {
        "type": "stripe",
        "name": "Stripe",
        "description": "Stripe integration allows you to collect payments with Stripe.",
        "capabilities": [
          {
            "type": "calculateTax",
            "key": "stripe_calculate_tax",
            "name": "Calculate Tax",
            "description": "Stripe Tax calculates tax portion of the invoices."
          },
          {
            "type": "invoiceCustomers",
            "key": "stripe_invoice_customers",
            "name": "Invoice Customers",
            "description": "Stripe invoices customers with due amount."
          },
          {
            "type": "collectPayments",
            "key": "stripe_collect_payments",
            "name": "Collect Payments",
            "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method."
          }
        ],
        "installMethods": [
          "with_oauth2",
          "with_api_key"
        ]
      },
      "createdAt": "2024-01-01T01:01:01.001Z",
      "updatedAt": "2024-01-01T01:01:01.001Z",
      "stripeAccountId": "acct_123456789",
      "livemode": true,
      "maskedAPIKey": "sk_live_************abc"
    },
    "payment": {
      "id": "01G65Z755AFWAKHE12NY0CQ9FH",
      "type": "stripe",
      "name": "Stripe",
      "status": "ready",
      "listing": {
        "type": "stripe",
        "name": "Stripe",
        "description": "Stripe integration allows you to collect payments with Stripe.",
        "capabilities": [
          {
            "type": "calculateTax",
            "key": "stripe_calculate_tax",
            "name": "Calculate Tax",
            "description": "Stripe Tax calculates tax portion of the invoices."
          },
          {
            "type": "invoiceCustomers",
            "key": "stripe_invoice_customers",
            "name": "Invoice Customers",
            "description": "Stripe invoices customers with due amount."
          },
          {
            "type": "collectPayments",
            "key": "stripe_collect_payments",
            "name": "Collect Payments",
            "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method."
          }
        ],
        "installMethods": [
          "with_oauth2",
          "with_api_key"
        ]
      },
      "createdAt": "2024-01-01T01:01:01.001Z",
      "updatedAt": "2024-01-01T01:01:01.001Z",
      "stripeAccountId": "acct_123456789",
      "livemode": true,
      "maskedAPIKey": "sk_live_************abc"
    }
  }
}