SubscriptionUpdateParameters interface
Detail pembaruan langganan.
Properti
| allow |
Menentukan apakah pelacakan dapat diaktifkan |
| display |
Nama langganan. |
| expiration |
Tanggal kedaluwarsa langganan. Pengaturannya hanya untuk tujuan audit dan langganan tidak secara otomatis kedaluwarsa. Siklus hidup langganan dapat dikelola dengan menggunakan properti |
| owner |
Jalur pengidentifikasi pengguna: /users/{userId} |
| primary |
Kunci langganan utama. |
| scope | Cakupan seperti /products/{productId} atau /apis atau /apis/{apiId} |
| secondary |
Kunci langganan sekunder. |
| state | Status langganan. Status yang mungkin * aktif - langganan aktif, * ditangguhkan - langganan diblokir, dan pelanggan tidak dapat memanggil API produk apa pun, * dikirimkan - permintaan langganan telah dibuat oleh pengembang, tetapi belum disetujui atau ditolak, * ditolak - permintaan langganan telah ditolak oleh administrator, * dibatalkan - langganan telah dibatalkan oleh pengembang atau administrator, * kedaluwarsa – langganan mencapai tanggal kedaluwarsa dan dinonaktifkan. |
| state |
Komentar yang menjelaskan perubahan status langganan oleh administrator saat status diubah menjadi 'ditolak'. |
Detail Properti
allowTracing
Menentukan apakah pelacakan dapat diaktifkan
allowTracing?: boolean
Nilai Properti
boolean
displayName
Nama langganan.
displayName?: string
Nilai Properti
string
expirationDate
Tanggal kedaluwarsa langganan. Pengaturannya hanya untuk tujuan audit dan langganan tidak secara otomatis kedaluwarsa. Siklus hidup langganan dapat dikelola dengan menggunakan properti state. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
expirationDate?: Date
Nilai Properti
Date
ownerId
Jalur pengidentifikasi pengguna: /users/{userId}
ownerId?: string
Nilai Properti
string
primaryKey
Kunci langganan utama.
primaryKey?: string
Nilai Properti
string
scope
Cakupan seperti /products/{productId} atau /apis atau /apis/{apiId}
scope?: string
Nilai Properti
string
secondaryKey
Kunci langganan sekunder.
secondaryKey?: string
Nilai Properti
string
state
Status langganan. Status yang mungkin * aktif - langganan aktif, * ditangguhkan - langganan diblokir, dan pelanggan tidak dapat memanggil API produk apa pun, * dikirimkan - permintaan langganan telah dibuat oleh pengembang, tetapi belum disetujui atau ditolak, * ditolak - permintaan langganan telah ditolak oleh administrator, * dibatalkan - langganan telah dibatalkan oleh pengembang atau administrator, * kedaluwarsa – langganan mencapai tanggal kedaluwarsa dan dinonaktifkan.
state?: SubscriptionState
Nilai Properti
stateComment
Komentar yang menjelaskan perubahan status langganan oleh administrator saat status diubah menjadi 'ditolak'.
stateComment?: string
Nilai Properti
string