Бүтээгдэхүүн ба үнэ
Бүтээгдэхүүн (product) нь таны зарж буй бараа, үйлчилгээг Byl дээр төлөөлөх объект юм. Үнэ (price) нь тухайн бүтээгдэхүүний нэг худалдаалах хувилбар — нэг бүтээгдэхүүн олон үнэтэй байж болно (жишээ нь сарын болон жилийн үнэ).
Бүтээгдэхүүн, үнэ хоёр нь дараах боломжуудын суурь болдог:
- Checkout —
price(lookup key) эсвэлprice_id-гаар бүртгэлтэй үнийг зааж худалдан авалт үүсгэнэ. - Захиалга (subscription) — давтагдах (recurring) үнэтэй checkout төлөгдөхөд захиалга автоматаар үүснэ.
- Хөнгөлөлтийн код — "Сонгосон бүтээгдэхүүн" хүрээтэй хөнгөлөлт нь бүртгэлтэй бүтээгдэхүүнтэй холбогдож ажиллана.
Бүртгэлтэй үнэ vs price_data
Checkout-д бүтээгдэхүүнээ Byl-д бүртгэхгүйгээр price_data-гаар шууд дамжуулж болдог ч энэ тохиолдолд захиалга (subscription) болон бүтээгдэхүүний хямдралтай хөнгөлөлтийн код ажиллахгүй. Тогтмол худалдаалдаг бүтээгдэхүүнээ бүртгэж, lookup key-гээр нь ашиглахыг зөвлөж байна. Дэлгэрэнгүйг Checkout — Бүтээгдэхүүн заах хэсгээс уншина уу.
Бүтээгдэхүүн үүсгэх
- Удирдлагын буланд төслийнхөө Бүтээгдэхүүн цэсээр орно.
- Шинэ бүтээгдэхүүн товчийг дарна.
- Дараах мэдээллийг бөглөнө:
- Нэр (заавал) — 255 тэмдэгт хүртэл. Checkout хуудсан дээр харилцагчид харагдана.
- Тайлбар (сонголттой) — 1024 тэмдэгт хүртэл.
- Зураг (сонголттой) — JPEG эсвэл PNG, 12MB хүртэл.
- Хамгийн багадаа нэг үнэ нэмнэ (доорх хэсгийг үзнэ үү).
- Хадгалснаар бүтээгдэхүүн үүснэ.
Үнэ
Үнэ бүр дараах тохиргоотой:
| Талбар | Тайлбар |
|---|---|
| Дүн | Нэгж үнэ, төгрөгөөр. |
| Төрөл | Нэг удаагийн (өгөгдмөл) эсвэл Давтагдах (recurring). |
| Мөчлөг | Зөвхөн давтагдах үнэд: сар эсвэл жил, 1–12 мөчлөгийн тоотой (жишээ нь "3 сар тутам"). |
| Lookup key | Үнийг кодоос дуудах, санахад хялбар нэр (сонголттой, доорх хэсгийг үзнэ үү). |
Бүтээгдэхүүний эхний үнэ автоматаар үндсэн үнэ болно. Үндсэн үнэ нь удирдлагын булангийн жагсаалтад харагдах үнэ юм.
Захиалгатай холбогдсон үнийг устгах боломжгүй
Идэвхтэй эсвэл өмнө нь үүссэн захиалга (subscription) холбогдсон үнийг устгах боломжгүй — системд түүхийн бүрэн бүтэн байдал хадгалагдана. Ийм үнийг ашиглахаа больё гэвэл шинэ үнэ нэмээд хуучин үнийг checkout-доо ашиглахаа болино.
Lookup key
Lookup key нь үнэд өгөх, төсөл дотроо давтагдашгүй нэр юм (200 тэмдэгт хүртэл). Жишээ нь: starter_monthly, growth_yearly, tshirt.
Lookup key ашигласнаар:
- Кодод үнийн ID (
price_id) хатуу бичих шаардлагагүй болно —items[0][price]талбарт lookup key-гээ дамжуулна. - Test болон Live төслүүдэд ижил lookup key өгвөл орчин солиход кодоо өөрчлөх шаардлагагүй.
- Үнийг дараа нь өөрчлөхөд (шинэ үнэ үүсгэж lookup key-г шилжүүлэхэд) кодод өөрчлөлт хийхгүй.
curl -X POST https://byl.mn/api/v1/projects/$BYL_PROJECT_ID/checkouts \
-H "Authorization: Bearer $BYL_TOKEN" \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"success_url": "https://example.mn/purchase/success",
"items": [
{ "price": "starter_monthly", "quantity": 1 }
]
}'Давтагдах үнэ ба захиалга
Захиалгын (subscription) үйлчилгээ ажиллуулахын тулд бүтээгдэхүүндээ давтагдах төрөлтэй үнэ үүсгэнэ:
- Үнэ нэмэхдээ төрлийг Давтагдах болгоно.
- Мөчлөгөө сонгоно — сар эсвэл жил, шаардлагатай бол мөчлөгийн тоог заана (жишээ нь 3 сар тутам).
- Lookup key өгөхийг зөвлөж байна (жишээ нь
starter_monthly).
Энэ үнэтэй checkout төлөгдмөгц захиалга автоматаар үүсч, сунгалтын сануулга, статусын шилжилт, webhook мэдэгдлийг Byl зохицуулна.
Нэг бүтээгдэхүүнд хэд хэдэн давтагдах үнэ байж болно (сарын/жилийн гэх мэт) — billing portal-ын "Багц солих" хэсэгт төслийн бүх давтагдах үнэ автоматаар харагдана.
Grace period
Захиалгын хугацаа хэтэрсэн үед шууд цуцлахгүй, тодорхой хоногийн турш past_due төлөвт байлгах grace period-ийг бүтээгдэхүүн тус бүрээр тохируулах боломжтой. Энэ тохиргоог идэвхжүүлэхийг хүсвэл бидэнтэй холбогдоорой.
client_reference_id
Өөрийн систем дэх бүтээгдэхүүний ID-г Byl-ийн бүтээгдэхүүнтэй холбохыг хүсвэл client_reference_id талбарыг ашиглана — webhook болон API-ийн хариун дахь product объектод энэ талбар буцаж ирдэг. price_data-гаар checkout үүсгэх үед мөн product_data[client_reference_id]-аар дамжуулж болно.
Дараагийн алхам
- Checkout — бүртгэлсэн үнээрээ худалдан авалт үүсгэх
- Subscriptions — давтагдах үнэ дээр захиалга ажиллуулах
- Хөнгөлөлтийн код — бүтээгдэхүүнд хөнгөлөлт тохируулах