Chuyển đến nội dung chính
POST
/
subscriptions
/
{subscription_id}
/
update-payment-method
JavaScript
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const response = await client.subscriptions.updatePaymentMethod('subscription_id', { type: 'new' });

console.log(response.payment_id);
{
  "client_secret": "<string>",
  "expires_on": "2023-11-07T05:31:56Z",
  "payment_id": "<string>",
  "payment_link": "<string>"
}
Cập nhật phương thức thanh toán cho một đăng ký. Điểm cuối này hỗ trợ cả đăng ký đang hoạt động và đăng ký trong on_hold trạng thái.
Đối với các đăng ký trong trạng thái on_hold, việc cập nhật phương thức thanh toán sẽ tự động tạo một khoản phí cho các khoản nợ còn lại, tạo một hóa đơn và kích hoạt lại đăng ký sang trạng thái active sau khi thanh toán thành công.

​
Trường hợp sử dụng

  • Đăng ký đang hoạt động: Cập nhật phương thức thanh toán khi thẻ hết hạn hoặc khách hàng muốn sử dụng một phương thức thanh toán khác
  • Đăng ký tạm hoãn: Kích hoạt lại các đăng ký đã tạm hoãn do thanh toán không thành công bằng cách cập nhật phương thức thanh toán
  • Quản lý phương thức thanh toán: Chuyển đổi giữa các phương thức thanh toán đã lưu hoặc thêm mới
Để liệt kê các phương thức thanh toán hiện có cho một khách hàng, hãy sử dụng API Liệt kê Phương thức Thanh toán. Điều này giúp bạn lấy các ID phương thức thanh toán có sẵn khi sử dụng type: "existing" để cập nhật phương thức thanh toán của một đăng ký.

​
Hành vi đối với Đăng ký Đang Hoạt Động

Khi cập nhật phương thức thanh toán cho một đăng ký đang hoạt động:
  • Phương thức thanh toán được cập nhật ngay lập tức
  • Không có khoản phí nào được tạo ra
  • Đăng ký vẫn giữ trạng thái hoạt động
  • Các lần gia hạn trong tương lai sẽ sử dụng phương thức thanh toán mới

​
Hành vi đối với Đăng Ký Tạm Hoãn

Khi cập nhật phương thức thanh toán cho một đăng ký trong trạng thái on_hold:
  1. Một khoản phí tự động được tạo ra cho các khoản nợ còn lại
  2. Một hóa đơn được tạo ra cho khoản phí
  3. Thanh toán được xử lý bằng phương thức thanh toán mới
  4. Sau khi thanh toán thành công, đăng ký được kích hoạt lại sang trạng thái active
  5. Bạn sẽ nhận được các sự kiện webhook: payment.succeeded tiếp theo là subscription.active
Nếu thanh toán không thành công sau khi cập nhật phương thức thanh toán cho một đăng ký on_hold, đăng ký sẽ vẫn ở trạng thái on_hold. Theo dõi các sự kiện webhook để theo dõi trạng thái thanh toán.

​
Sự kiện Webhook

Khi cập nhật một phương thức thanh toán cho một đăng ký on_hold, bạn sẽ nhận được các sự kiện webhook sau:
  1. payment.succeeded - Khoản phí cho các khoản nợ còn lại đã thành công
  2. subscription.active - Đăng ký đã được kích hoạt lại

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
subscription_id
string
required

Subscription Id

Body

application/json
​
type
enum<string>
required
Tùy chọn có sẵn:
new
​
return_url
string | null

Response

Payment method updated

​
client_secret
string | null
​
expires_on
string<date-time> | null
​
payment_id
string | null
​
payment_link
string | null