Langsung ke konten utama

Pendahuluan

Metadata memungkinkan Anda untuk menyimpan informasi tambahan yang terstruktur tentang objek Anda di Dodo Payments. Anda dapat melampirkan metadata ke sebagian besar objek Dodo Payments, termasuk pembayaran, langganan, dan lainnya.

Ikhtisar

  • Kunci metadata dapat memiliki panjang hingga 40 karakter
  • Nilai metadata dapat berupa string, angka, atau boolean; string dapat memiliki panjang hingga 500 karakter
  • Objek, array, dan null tidak diterima sebagai nilai metadata
  • Anda dapat memiliki hingga 50 pasang kunci-nilai metadata per objek
  • Kunci hanya boleh berisi karakter alfanumerik, tanda hubung, dan garis bawah
  • Metadata tidak dapat dicari menggunakan API kami tetapi dikembalikan dalam respons API dan webhook

Kasus Penggunaan

Metadata berguna untuk:
  • Menyimpan ID atau referensi eksternal
  • Menambahkan anotasi internal
  • Menghubungkan objek Dodo Payments ke sistem Anda
  • Mengkategorikan transaksi
  • Menambahkan atribut kustom untuk pelaporan

Menambahkan Metadata

Anda dapat menambahkan metadata saat membuat atau memperbarui objek melalui API. Untuk produk, Anda juga memiliki opsi untuk menambahkan metadata langsung dari UI dasbor.

Melalui API

Melalui UI Dasbor (Hanya Produk)

Untuk produk, Anda juga dapat menambahkan metadata langsung dari dasbor Dodo Payments saat membuat atau mengedit produk. Bagian metadata memungkinkan Anda untuk dengan mudah menambahkan pasangan kunci-nilai kustom tanpa menulis kode.
Product metadata interface in Dodo Payments dashboard
Menggunakan UI dashboard untuk metadata produk sangat berguna bagi anggota tim non-teknis yang perlu mengelola informasi produk dan kategori.

Mengambil Metadata

Metadata disertakan dalam respons API saat mengambil objek:

Pencarian dan Penyaringan

Meskipun metadata tidak dapat dicari secara langsung melalui API kami, Anda dapat:
  1. Menyimpan pengidentifikasi penting dalam metadata
  2. Mengambil objek menggunakan ID utama mereka
  3. Menyaring hasil dalam kode aplikasi Anda

Praktik Terbaik

Lakukan:

  • Gunakan konvensi penamaan yang konsisten untuk kunci metadata
  • Dokumentasikan skema metadata Anda secara internal
  • Jaga nilai tetap singkat dan bermakna
  • Gunakan metadata hanya untuk data statis
  • Pertimbangkan menggunakan awalan untuk sistem yang berbeda (misalnya, crm_id, inventory_sku)

Jangan:

  • Menyimpan data sensitif dalam metadata
  • Menggunakan metadata untuk nilai yang sering berubah
  • Mengandalkan metadata untuk logika bisnis yang kritis
  • Menyimpan informasi duplikat yang tersedia di tempat lain dalam objek
  • Menggunakan karakter khusus dalam kunci metadata

Objek yang Didukung

Metadata didukung pada objek berikut:

Webhook dan Metadata

Metadata disertakan dalam peristiwa webhook, memudahkan untuk menangani notifikasi dengan data kustom Anda:
Terakhir diubah pada 9 Juli 2026