0bull API
boolean · requiredinteger · requirednumber · requirednumberbooleanstring
boolean · requiredinteger | null · min: 1 · max: 50string | null · enumstring · requiredinteger · requiredstring · required
boolean · requiredinteger | null · min: 1 · max: 50integer | null · min: -49 · max: 49boolean · requiredstring · requiredinteger · requiredinteger · requiredstring · required
string · uuid · requiredstring · requiredstring · enum · requiredinteger · requiredstring · requiredstring · requiredstring | null · required
Billing
Get billing summary
GET
https://0bull.net/api
/v1/billing
Returns your active rentals, pending orders, pricing and renewal dates.
Get billing summary › Responses
BillingSummaryResource
subscribedphonesprice_per_phoneobject[] · required
monthlyon_grace_periodobject[]
status is Stripe's own subscription status.
hintStart a rental checkout
POST
https://0bull.net/api
/v1/billing/rentals
Returns a Stripe Checkout link. No phones are assigned until checkout completes and the order is fulfilled.
Start a rental checkout › Request Body
accept_termsphonescountryEnum values:
AD
AE
AF
AG
AI
AL
AM
AO
array | null · minItems: 1 · maxItems: 10
Start a rental checkout › Responses
StartRentalResource
checkout_urlphonesobject[] · required
nextRequest a phone count change
POST
https://0bull.net/api
/v1/billing/requests
Returns 202 if the change needs approval, or 201 if your standing allowance let it apply immediately.
Request a phone count change › Request Body
accept_termsphonesaddRequest a phone count change › Responses
RequestPhoneCountChangeAppliedResource
appliedrequest_idfrom_phonesto_phonesnextGet a billing request
GET
https://0bull.net/api
/v1/billing/requests/{billingRequest}
Returns one of your billing requests by id. Returns 404 if the id does not exist or belongs to another account.
path Parameters
billingRequestThe billing request ID
Get a billing request › Responses
BillingRequestResource
request_idstatuspending, approved, declined or failed, or the computed
expired once a pending request has aged out.
Enum values:
pending
approved
declined
failed
expired
to_phonesapproval_urlexpires_atresolved_at