V1 Subscriptions
Subscription management (v1)
List subscriptions with filtering and pagination.
Additional filter query parameters are available depending on the resource.
Account API key authentication. Pass an API key as a Bearer token in the Authorization header. An account may have multiple named keys; any of them grants full access to all endpoints — equivalent to all OAuth scopes.
Page number (1-based)
1Items per page (default 50)
50Sort field (prefix with - for descending)
-created_atFull-text search query
Paginated list of resources
Current page number
1Items per page
50Total number of items
250Total number of pages
5Unauthorized
Forbidden / insufficient scope
Internal server error
GET /v1/subscriptions HTTP/1.1
Host: api.spiffy.co
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": [],
"page": 1,
"per_page": 50,
"total": 250,
"total_pages": 5
}Reports metered usage for a subscription. Returns the Stripe usage record(s).
Account API key authentication. Pass an API key as a Bearer token in the Authorization header. An account may have multiple named keys; any of them grants full access to all endpoints — equivalent to all OAuth scopes.
Subscription ID
Usage quantity to report
Unix timestamp for the usage event (defaults to now)
Stripe usage record(s)
Unauthorized
Forbidden / insufficient scope
Subscription not found
Internal server error
POST /v1/subscriptions/{subscription_id}/usage HTTP/1.1
Host: api.spiffy.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"quantity": 1,
"timestamp": 1
}No content
Last updated