v2

latestOpenAPI 3.1.12026-08-06856719.6 KB

Get saved card details

Use this API to get the detail of recurring billing with a saved card. If the card is saved the response will have the card details (The last 4 digits and card brand). You can use the card details to display it to the users so they are aware of which card is saved and give them the option to change the card by navigating to the “url”

get/v1/recurring-billing/{recurring_billing_id}

Path parameters

recurring_billing_idstring required

Headers

X-BUSINESS-API-KEYstring required
Example:b286daabf9921b5a01a4621f026c111e046f8911feba212996c92159b98427d

Response

200

idstring
{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:get:responses:200:content:application/json:schema:properties:business_recurring_plans_id","oasType":"schema","type":"unknown"}
customer_namestring
customer_emailstring
{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:get:responses:200:content:application/json:schema:properties:customer_phone_number","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:get:responses:200:content:application/json:schema:properties:customer_phone_number_country_code","oasType":"schema","type":"unknown"}
namestring
descriptionstring
referencestring
cyclestring
{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:get:responses:200:content:application/json:schema:properties:cycle_repeat","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:get:responses:200:content:application/json:schema:properties:cycle_frequency","oasType":"schema","type":"unknown"}
currencystring
pricenumber
amountnumber
{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:get:responses:200:content:application/json:schema:properties:times_to_be_charged","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:get:responses:200:content:application/json:schema:properties:times_charged","oasType":"schema","type":"unknown"}
statusstring
send_emailnumber
save_cardnumber
redirect_urlstring
payment_methodsstring[]
payment_provider_charge_methodstring
created_atstring
updated_atstring
{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:get:responses:200:content:application/json:schema:properties:pause_from","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:get:responses:200:content:application/json:schema:properties:pause_until","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/v1/recurring-billing/{recurring_billing_id}:get:responses:200:content:application/json:schema:properties:expires_at","oasType":"schema","type":"unknown"}
urlstring
total_chargenumber