SubscriptionCreateParameters interface
Detail pembuatan langganan.
Properti
| allow |
Menentukan apakah pelacakan dapat diaktifkan |
| display |
Nama langganan. |
| owner |
Pengguna (jalur id pengguna) yang langganannya sedang dibuat dalam formulir /users/{userId} |
| primary |
Kunci langganan utama. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis. |
| scope | Cakupan seperti /products/{productId} atau /apis atau /apis/{apiId}. |
| secondary |
Kunci langganan sekunder. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis. |
| state | Status langganan awal. Jika tidak ada nilai yang ditentukan, langganan dibuat dengan status Dikirim. 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. |
Detail Properti
allowTracing
Menentukan apakah pelacakan dapat diaktifkan
allowTracing?: boolean
Nilai Properti
boolean
displayName
Nama langganan.
displayName?: string
Nilai Properti
string
ownerId
Pengguna (jalur id pengguna) yang langganannya sedang dibuat dalam formulir /users/{userId}
ownerId?: string
Nilai Properti
string
primaryKey
Kunci langganan utama. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis.
primaryKey?: string
Nilai Properti
string
scope
Cakupan seperti /products/{productId} atau /apis atau /apis/{apiId}.
scope?: string
Nilai Properti
string
secondaryKey
Kunci langganan sekunder. Jika tidak ditentukan selama kunci permintaan akan dibuat secara otomatis.
secondaryKey?: string
Nilai Properti
string
state
Status langganan awal. Jika tidak ada nilai yang ditentukan, langganan dibuat dengan status Dikirim. 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