Biftpaydocs
Dashboard

Subscriptions

A customer's saved cards

get/v1/customers/{id}/payment_methods

Parameters

idstring (uuid)in pathrequired
bash
curl https://sandbox.api.biftpay.com/v1/customers/{id}/payment_methods \
  -H "Authorization: Bearer bp_test_..."

Responses

  • 200
    OKobject
    Fields
    object"list"required
    dataarray of PaymentMethodrequired
    Fields of data
    idstring (uuid)required
    object"payment_method"required
    brandstring | null
    last4stringrequired
    exp_monthintegerrequired
    exp_yearintegerrequired
    created_atstring (date-time)required
    has_moreboolean

List subscriptions

get/v1/subscriptions

Parameters

customerstring (uuid)in query

Only this customer's

statusactive | past_due | canceledin query
bash
curl https://sandbox.api.biftpay.com/v1/subscriptions \
  -H "Authorization: Bearer bp_test_..."

Responses

  • 200
    OKobject
    Fields
    object"list"required
    dataarray of Subscriptionrequired
    Fields of data
    idstring (uuid)required
    object"subscription"required
    livemodebooleanrequired
    customerstring (uuid)required
    payment_methodstring (uuid)required
    brandstring (uuid) | null
    descriptionstringrequired
    amountintegerrequired

    Minor units (kobo, cents).

    at least 0

    currencyNGN | USDrequired
    intervalweekly | monthly | yearlyrequired
    statusactive | past_due | canceledrequired
    next_charge_atstring (date-time)required
    failed_attemptsintegerrequired
    latest_paymentstring (uuid) | null
    created_atstring (date-time)required
    canceled_atstring (date-time) | null
    has_moreboolean

Charge a saved card every week, month or year

post/v1/subscriptions

Save the card first: create a payment with save_payment_method true and a customer, and pay it at checkout. The first charge happens at start_at (default now).

Parameters

Idempotency-Keystringin headerrequired

A unique key per logical request, for example a UUID. Up to 255 characters.

up to 255 characters

Body

payment_methodstring (uuid)required
amountintegerrequired

at least 1

currencyNGN | USD
intervalweekly | monthly | yearlyrequired
descriptionstringrequired

up to 200 characters

brandstring (uuid)
start_atstring (date-time)
bash
curl -X POST https://sandbox.api.biftpay.com/v1/subscriptions \
  -H "Authorization: Bearer bp_test_..." \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "payment_method": "…",
    "amount": 1,
    "interval": "weekly",
    "description": "…"
  }'

Responses

  • 201
    OKSubscription
    Fields
    idstring (uuid)required
    object"subscription"required
    livemodebooleanrequired
    customerstring (uuid)required
    payment_methodstring (uuid)required
    brandstring (uuid) | null
    descriptionstringrequired
    amountintegerrequired

    Minor units (kobo, cents).

    at least 0

    currencyNGN | USDrequired
    intervalweekly | monthly | yearlyrequired
    statusactive | past_due | canceledrequired
    next_charge_atstring (date-time)required
    failed_attemptsintegerrequired
    latest_paymentstring (uuid) | null
    created_atstring (date-time)required
    canceled_atstring (date-time) | null
  • 400
    Invalid request

Cancel a subscription

post/v1/subscriptions/{id}/cancel

Parameters

idstring (uuid)in pathrequired
Idempotency-Keystringin headerrequired

A unique key per logical request, for example a UUID. Up to 255 characters.

up to 255 characters

bash
curl -X POST https://sandbox.api.biftpay.com/v1/subscriptions/{id}/cancel \
  -H "Authorization: Bearer bp_test_..." \
  -H "Idempotency-Key: $(uuidgen)"

Responses

  • 200
    OKSubscription
    Fields
    idstring (uuid)required
    object"subscription"required
    livemodebooleanrequired
    customerstring (uuid)required
    payment_methodstring (uuid)required
    brandstring (uuid) | null
    descriptionstringrequired
    amountintegerrequired

    Minor units (kobo, cents).

    at least 0

    currencyNGN | USDrequired
    intervalweekly | monthly | yearlyrequired
    statusactive | past_due | canceledrequired
    next_charge_atstring (date-time)required
    failed_attemptsintegerrequired
    latest_paymentstring (uuid) | null
    created_atstring (date-time)required
    canceled_atstring (date-time) | null
  • 404
    Not found, or not visible to this key