Change payment method
Payment agreements define how a customer pays their bills and subscriptions. In tebio, payment agreements can be used either for a customer in general or for a specific subscription.
When do I need this function?
Section titled “When do I need this function?”- A customer informs you of new bank details, for example after an account change.
- A business customer wants to bill a specific subscription using a different SEPA mandate than other subscriptions.
- A customer has created a new PayPal account in the self-care / customer portal and you would like to select this as the active payment method for an ongoing subscription.
Requirements
Section titled “Requirements”- You are logged in to the tebio business portal.
- You are in the customer profile and have permission to manage payment data.
[!IMPORTANT] House bank methods and digital payment methods For security and authorization reasons, tebio differentiates between house bank methods and digital payment methods:
- House bank methods such as SEPA direct debit or bank transfer: As an administrator, you can create these for the customer directly in the tebio business portal, for example after receiving a written mandate.
- Digital payment methods such as PayPal or credit card: These methods require authentication or approval by the customer with the respective payment provider. Therefore, digital payment agreements can only be added by the customer via the self-care / customer portal.
Step-by-step instructions
Section titled “Step-by-step instructions”You have two ways to manage payment arrangements, depending on whether you want to work at the customer level or at the subscription level.
Way 1: Create payment agreement at customer level
Section titled “Way 1: Create payment agreement at customer level”This method is suitable if you want to store new bank details as an available payment method for the customer.
- Open the customer’s detailed view and go to the Payments tab.
- You see an overview of the customer’s existing payment agreements. This can also include digital payment methods that the customer has authorized himself.
- Click +Add in the top right corner.
- In the dropdown, select the desired house bank method, for example SEPA direct debit.
- Enter the account holder and IBAN.
- Click Create.
Way 2: Change payment method for a specific subscription
Section titled “Way 2: Change payment method for a specific subscription”Often a payment method should not only be deposited, but also assigned directly to an ongoing subscription.
- Navigate to the Subscriptions tab in the customer profile.
- Use the dropdown to select the subscription you want.
- On the right side you will find the Payment method block, which shows the payment method currently used for this subscription.
You now have two options available here:
-
Option A: Create new method Click on + New to enter a new house bank method, for example SEPA direct debit or bank transfer, as in method 1. If you activate the checkbox Use this payment agreement for the subscription now, the new payment agreement will be saved and assigned directly to this subscription.
-
Option B: Assign existing method Click the Edit pencil icon if the customer already has multiple payment methods available, for example PayPal. A list of all available payment methods opens. Select the desired payment method, for example PayPal, and click Save.
Result
Section titled “Result”The new or changed payment method is now stored. Future invoices or invoices for the selected subscription will be processed using the updated payment method.
Notes and typical errors
Section titled “Notes and typical errors”- Customer wants to change credit card: If a customer wants to change their credit card, you cannot store the new credit card number for them in the tebio business portal. Refer the customer to the self-care / customer portal so that they can complete the digital authentication themselves. After the customer has stored the new card there, you can assign it to the desired subscription using the Subscriptions tab.
API Notes
Section titled “API Notes”Payment agreements are managed through Customer and Subscription resources:
| End point | Method | Description | OperationId |
|---|---|---|---|
/v1/customer/{uuid}/payment-arrangement | POST | Create a payment agreement for a customer | createPaymentArrangement |
/v1/customer/{uuid}/payment-arrangement | GET | List a customer’s payment arrangements | listPaymentArrangements |
/v1/subscription/{uuid} | PATCH | Change payment method for a subscription | updateSubscription |
Change payment method of a subscription: The assignment of an existing payment arrangement to a subscription is typically done via an update (PATCH) of the subscription entity, in which the paymentArrangementId is included.