Lấy Bộ Sưu Tập Sản Phẩm

Lấy thông tin chi tiết về một bộ sưu tập sản phẩm cụ thể.

GET /product-collections/{id}

JavaScript

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 productCollection = await client.productCollections.retrieve('pdc_8BWv0hojwUH7iCDabr0NI');

console.log(productCollection.id);

import os
from dodopayments import DodoPayments

client = DodoPayments(
    bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"),  # This is the default and can be omitted
)
product_collection = client.product_collections.retrieve(
    "pdc_8BWv0hojwUH7iCDabr0NI",
)
print(product_collection.id)

package main

import (
	"context"
	"fmt"

	"github.com/dodopayments/dodopayments-go"
	"github.com/dodopayments/dodopayments-go/option"
)

func main() {
	client := dodopayments.NewClient(
		option.WithBearerToken("My Bearer Token"),
	)
	productCollection, err := client.ProductCollections.Get(context.TODO(), "pdc_8BWv0hojwUH7iCDabr0NI")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", productCollection.ID)
}

package com.dodopayments.api.example;

import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.productcollections.ProductCollection;
import com.dodopayments.api.models.productcollections.ProductCollectionRetrieveParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();

        ProductCollection productCollection = client.productCollections().retrieve("pdc_8BWv0hojwUH7iCDabr0NI");
    }
}

package com.dodopayments.api.example

import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.productcollections.ProductCollection
import com.dodopayments.api.models.productcollections.ProductCollectionRetrieveParams

fun main() {
    val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()

    val productCollection: ProductCollection = client.productCollections().retrieve("pdc_8BWv0hojwUH7iCDabr0NI")
}

require "dodopayments"

dodo_payments = Dodopayments::Client.new(
  bearer_token: "My Bearer Token",
  environment: "test_mode" # defaults to "live_mode"
)

product_collection = dodo_payments.product_collections.retrieve("pdc_8BWv0hojwUH7iCDabr0NI")

puts(product_collection)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;

$client = new Client(
  bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
  environment: 'test_mode',
);

try {
  $productCollection = $client->productCollections->retrieve(
    'pdc_8BWv0hojwUH7iCDabr0NI'
  );

  var_dump($productCollection);
} catch (APIException $e) {
  echo $e->getMessage();
}

using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.ProductCollections;

DodoPaymentsClient client = new();

ProductCollectionRetrieveParams parameters = new()
{
    ID = "pdc_8BWv0hojwUH7iCDabr0NI"
};

var productCollection = await client.ProductCollections.Retrieve(parameters);

Console.WriteLine(productCollection);

use dodopayments::Client;

#[tokio::main]
async fn main() -> dodopayments::Result<()> {
    let client = Client::from_env()?;
    let id = "id";
    let result = client
        .product_collections()
        .retrieve()
        .id(id)
        .await?;
    println!("{result:?}");
    Ok(())
}

curl --request GET \
  --url https://test.dodopayments.com/product-collections/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "brand_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "groups": [
    {
      "group_id": "<string>",
      "products": [
        {
          "addons_count": 123,
          "files_count": 123,
          "has_credit_entitlements": true,
          "id": "<string>",
          "is_recurring": true,
          "license_key_enabled": true,
          "meters_count": 123,
          "product_id": "<string>",
          "status": true,
          "description": "<string>",
          "name": "<string>",
          "price": 123,
          "price_detail": {
            "discount": 123,
            "price": 123,
            "purchasing_power_parity": true,
            "type": "one_time_price",
            "pay_what_you_want": true,
            "suggested_price": 123,
            "tax_inclusive": true
          },
          "tax_inclusive": true
        }
      ],
      "status": true,
      "group_name": "<string>"
    }
  ],
  "id": "<string>",
  "name": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "image": "<string>"
}

Ủy quyền

Authorization · string · header · bắt buộc

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

Tham số đường dẫn

id · string · bắt buộc

Product Collection Id

Phản hồi

200

application/json

Product Collection Retrieved Successfully

brand_id · string · bắt buộc

Brand ID for the collection

created_at · string<date-time> · bắt buộc

Timestamp when the collection was created

groups · object[] · bắt buộc

Groups in this collection

Show child attributes

id · string · bắt buộc

Unique identifier for the product collection

name · string · bắt buộc

Name of the collection

updated_at · string<date-time> · bắt buộc

Timestamp when the collection was last updated

description · string | null

Description of the collection

effective_at_on_downgrade · null | enum<string>

Default effective_at setting for subscription plan downgrades (null = inherit from business)

Tùy chọn có sẵn: immediately, next_billing_date

effective_at_on_upgrade · null | enum<string>

Default effective_at setting for subscription plan upgrades (null = inherit from business)

Tùy chọn có sẵn: immediately, next_billing_date

image · string | null

URL of the collection image

on_payment_failure · null | enum<string>

Default behavior for subscription plan changes on payment failure (null = inherit from business)

Tùy chọn có sẵn: prevent_change, apply_change

proration_billing_mode_on_downgrade · null | enum<string>

Default proration billing mode for subscription plan downgrades (null = inherit from business)

Tùy chọn có sẵn: prorated_immediately, full_immediately, difference_immediately, do_not_bill

proration_billing_mode_on_upgrade · null | enum<string>

Default proration billing mode for subscription plan upgrades (null = inherit from business)

Tùy chọn có sẵn: prorated_immediately, full_immediately, difference_immediately, do_not_bill