Retrieve a StripeBalanceDebitAgreement

GET / v1 / stripe_balance_debit_agreements /:id

Retrieves a Stripe Balance Debit Agreement by its ID.

Parameters

• id string Required The ID of the StripeBalanceDebitAgreement to retrieve.

Returns

Returns a StripeBalanceDebitAgreement object.

cURL

Response

{ "id": "sbda_1Na5YT2eZvKYlo2Ctn7SPPuy", "object": "stripe_balance_debit_agreement", "financial_account": "fa_1Na5YT2eZvKYlo2Ctn7SPPuy", "livemode": false, "multi_use": null, "seller_network_business_profile": "snbp_1Na5YT2eZvKYlo2Ctn7SPPuz", "single_use": { "amount": 1000, "currency": "usd" }, "status": "active"}

Revoke a StripeBalanceDebitAgreement

POST / v1 / stripe_balance_debit_agreements /:id / revoke

Revokes a Stripe Balance Debit Agreement, preventing further use for creating payment methods.

Parameters

• id string Required The ID of the StripeBalanceDebitAgreement to revoke.

Returns

Returns the revoked StripeBalanceDebitAgreement object.

cURL

Response

{ "id": "sbda_1Na5YT2eZvKYlo2Ctn7SPPuy", "object": "stripe_balance_debit_agreement", "financial_account": "fa_1Na5YT2eZvKYlo2Ctn7SPPuy", "livemode": false, "multi_use": null, "seller_network_business_profile": "snbp_1Na5YT2eZvKYlo2Ctn7SPPuz", "single_use": { "amount": 1000, "currency": "usd" }, "status": "revoked"}