Billing

Creates a manual charge billing item for a customer.

Changed on
post/billing/manual-charge

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/billing/manual-charge
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Request body

namestring required

The name of the manual charge.

billingPeriodIdstring required

The billing period to add the charge to.

organizationIdstring required

The organization the charge is billed to.

customerIdstring uuid nullable

The member the charge is recorded against, for auditability. Optional — omit it for a charge that belongs to the organization as a whole rather than to one of its members.

customerMailstring nullable

The email address of the member named by CustomerId.

quantityinteger nullable

The number of units billed. The charge total is Quantity × UnitPrice, and the invoice line shows the unit breakdown.

unitPricenumber double nullable

The price per unit. Positive for fees, negative for refunds.

reason'PlatformFee' | 'Refund' | 'Other' | 'MinimumSpendCommitment' required
commentstring nullable

An optional comment describing the charge.

Response

OK

idstring required

The ID of the created billing item.

Changes

  • 9da534659e5fRevision changes
    • info

      the security scope api was added to the endpoint's security scheme OpenIdConnect

  • d779de93a5eeRevision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      the request property became nullable

    • info

      the request property became nullable

    • info

      the request property became optional

    • info

      the request property became optional