Sign in
billing

Cancel a recurring add-on at period end

Changed on

POST /billing/add-ons/ (purchase capacity), DELETE /billing/add-ons/{id}/ (stop a recurring add-on from renewing).

SubscriptionAddOnSerializer is a plain ModelSerializer -- no nested relation heavy enough to warrant a virtual model (see vinta_billing/virtual_models.py) -- so this does not mix in GenericVirtualModelViewMixin, unlike SubscriptionViewSet.

delete/billing/add-ons/{id}{format}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

format'.json' required
idstring required

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Response

idinteger required
resource_key'organization_members' | 'resource_calendars' | 'appointment_types' | 'bundle_calendars' | 'availability_windows' | 'webhook_subscriptions' | 'public_api_system_users' | 'event_occurrences' required
  • organization_members - Organization members
  • resource_calendars - Resource calendars
  • appointment_types - Appointment types
  • bundle_calendars - Bundle calendars
  • availability_windows - Availability windows
  • webhook_subscriptions - Webhook subscriptions
  • public_api_system_users - Public API system users
  • event_occurrences - Event occurrences
quantityinteger required
is_recurringboolean required
is_activeboolean required
external_idstring required
createdstring date-time required

Changes

  • e92afcb6b029Revision changes
    • ●

      added the new appointment_types enum value to the //// response property for the response status

    • ○

      removed the calendar_groups enum value from the //// response property for the response status

  • a5fdf3d27f1aRevision changes
    • ○

      endpoint added