App Store Server SDK

https://pub.dev/documentation/app_store_server_sdk/latest/
Admin
A Dart SDK for integrating with Apple's App Store Server API to manage in-app purchases,...
Tokens:32,760
Snippets:156
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### AppStoreServerAPI - Get All Subscription Statuses

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerAPI-class

Get the statuses for all of a customer’s subscriptions in your app.

```APIDOC
## GET /getAllSubscriptionStatuses

### Description
Get the statuses for all of a customer’s subscriptions in your app.

### Method
GET

### Endpoint
/getAllSubscriptionStatuses

### Parameters
#### Path Parameters
- **originalTransactionId** (String) - Required - The original transaction identifier for the customer.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **body** (StatusResponse) - A response object containing the status of all subscriptions for the customer.

#### Response Example
```json
{
  "body": {
    "subscriptionGroupIdentifier": "12345",
    "status": 2,
    "hasPricedEntitlement": true,
    "expiresDate": 1710422400000,
    "gracePeriodExpiresDate": null,
    "renewalIntentDate": null,
    "effectiveBillingPeriodStartDate": 1678886400000,
    "effectiveBillingPeriodEndDate": 1710422400000,
    "autoResumeDate": null,
    "originalPurchaseDate": 1678886400000,
    "statusModifiedDate": 1678886400000
  }
}
```
```

--------------------------------

### AppStoreServerAPI - Get Refund History

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerAPI-class

Get a list of all refunded in-app purchases in your app for a customer.

```APIDOC
## GET /getRefundHistory

### Description
Get a list of all refunded in-app purchases in your app for a customer.

### Method
GET

### Endpoint
/getRefundHistory

### Parameters
#### Path Parameters
- **originalTransactionId** (String) - Required - The original transaction identifier for the customer.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **body** (RefundLookupResponse) - A response object containing the refund history for the customer.

#### Response Example
```json
{
  "body": {
    "refunds": [
      {
        "productId": "com.example.consumable",
        "originalTransactionId": "1234567890",
        "refundIntentDate": 1678886400000,
        "refundRequestDate": 1678886400000,
        "refundDurationDays": 30,
        "refundType": "full"
      }
    ]
  }
}
```
```

--------------------------------

### JWSTransactionDecodedPayload Constructor Example

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/JWSTransactionDecodedPayload-class

Demonstrates the creation of a JWSTransactionDecodedPayload object using its primary constructor. This constructor requires numerous parameters to fully define a transaction, including IDs, dates, product details, and user account information.

```dart
final transactionPayload = JWSTransactionDecodedPayload(
  appAccountToken: 'user123-app-account-token',
  bundleId: 'com.example.myapp',
  expiresDate: 1735689600000, // Example: January 1, 2025 00:00:00 GMT
  inAppOwnershipType: 'PURCHASED',
  isUpgraded: false,
  offerIdentifier: 'promo123',
  offerType: 'PROMOTIONAL',
  originalPurchaseDate: 1640995200000, // Example: January 1, 2022 00:00:00 GMT
  originalTransactionId: 'original_txn_id_123',
  productId: 'com.example.myapp.premium',
  purchaseDate: 1672531200000, // Example: January 1, 2023 00:00:00 GMT
  quantity: 1,
  revocationDate: null,
  signedDate: 1672531205000, // Example: January 1, 2023 00:00:05 GMT
  subscriptionGroupIdentifier: 'sub_group_abc',
  transactionId: 'txn_id_456',
  type: 'PRODUCTION',
  webOrderLineItemId: 'web_order_id_789',
);
```

--------------------------------

### AppStoreServerHttpClient Get URL

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerHttpClient-class

Constructs a URL for the App Store Server API using a given path and the client's configured environment. This utility helps in creating correctly formatted API endpoints.

```dart
Uri getUrl(String path, {Map<String, dynamic>? queryParameters})
```

--------------------------------

### HTTP GET Request with ITunesHttpClient

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesHttpClient-class

Performs an HTTP GET request to a given URL using the ITunesHttpClient. This method is suitable for retrieving data from the iTunes API.

```dart
Future<Response> getRequest(Uri url) async {
  final response = await iTunesHttpClient.get(url);
  return response;
}
```

--------------------------------

### JWSRenewalInfoDecodedPayload toString Method

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/JWSRenewalInfoDecodedPayload-class

Shows how to use the `toString` method to get a string representation of a JWSRenewalInfoDecodedPayload object. This is useful for debugging and logging.

```dart
JWSRenewalInfoDecodedPayload renewalInfo = JWSRenewalInfoDecodedPayload.new(
  'autoRenewProductId',
  1, 
  null, 
  null, 
  false, 
  null, 
  null, 
  'originalTransactionId',
  null, 
  'productId',
  1678886400000
);

String representation = renewalInfo.toString();

print('String representation: $representation');
```

--------------------------------

### AppStoreServerAPI - Get Transaction History

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerAPI-class

Get a customer’s in-app purchase transaction history for your app.

```APIDOC
## GET /getTransactionHistory

### Description
Get a customer’s in-app purchase transaction history for your app.

### Method
GET

### Endpoint
/getTransactionHistory

### Parameters
#### Path Parameters
- **originalTransactionId** (String) - Required - The original transaction identifier for the customer.
- **revision** (String) - Optional - A specific revision of the transaction history to retrieve.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **body** (HistoryResponse) - A response object containing the transaction history.

#### Response Example
```json
{
  "body": {
    "revision": "1",
    "hasMore: true,
    "transactions": [
      {
        "transactionId": "9876543210",
        "originalTransactionId": "1234567890",
        "productId": "com.example.consumable",
        "purchaseDate": 1678886400000,
        "quantity": 1,
        "type": "Consumable"
      }
    ]
  }
}
```
```

--------------------------------

### Implement HTTP GET Request with Read Method in Dart

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerHttpClient/read

The 'read' method in Dart sends an HTTP GET request to a specified URL with optional headers. It returns the response body as a String and throws a ClientException for non-success status codes. It relies on the 'get' function and '_checkResponseSuccess' for operation.

```dart
@override
Future<String> read(Uri url, {Map<String, String>? headers}) async {
  final response = await get(url, headers: headers);
  _checkResponseSuccess(url, response);
  return response.body;
}
```

--------------------------------

### AppStoreServerAPI - Look Up Order ID

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerAPI-class

Get a customer’s in-app purchases from a receipt using the order ID.

```APIDOC
## GET /lookUpOrderId

### Description
Get a customer’s in-app purchases from a receipt using the order ID.

### Method
GET

### Endpoint
/lookUpOrderId

### Parameters
#### Path Parameters
- **orderId** (String) - Required - The order ID associated with the purchase.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **body** (OrderLookupResponse) - A response object containing the order details.

#### Response Example
```json
{
  "body": {
    "orderId": "1234567890",
    "transactionId": "9876543210",
    "productId": "com.example.consumable",
    "purchaseDate": 1678886400000,
    "quantity": 1,
    "type": "Consumable"
  }
}
```
```

--------------------------------

### JWSTransactionDecodedPayload fromJson Example

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/JWSTransactionDecodedPayload-class

Illustrates how to parse a JSON map into a JWSTransactionDecodedPayload object. This is useful when receiving transaction data from an API response. The `fromJson` factory constructor handles the mapping of JSON keys to class properties.

```dart
final Map<String, dynamic> transactionJson = {
  'appAccountToken': 'user123-app-account-token',
  'bundleId': 'com.example.myapp',
  'expiresDate': 1735689600000,
  'inAppOwnershipType': 'PURCHASED',
  'isUpgraded': false,
  'offerIdentifier': 'promo123',
  'offerType': 'PROMOTIONAL',
  'originalPurchaseDate': 1640995200000,
  'originalTransactionId': 'original_txn_id_123',
  'productId': 'com.example.myapp.premium',
  'purchaseDate': 1672531200000,
  'quantity': 1,
  'revocationDate': null,
  'signedDate': 1672531205000,
  'subscriptionGroupIdentifier': 'sub_group_abc',
  'transactionId': 'txn_id_456',
  'type': 'PRODUCTION',
  'webOrderLineItemId': 'web_order_id_789',
};

final JWSTransactionDecodedPayload transactionPayload = JWSTransactionDecodedPayload.fromJson(transactionJson);
```

--------------------------------

### Implement toString Method for Object Representation

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ApiException/toString

This snippet demonstrates the implementation of the toString method, which is used to provide a human-readable string representation of an object. It's particularly useful for debugging and logging purposes. This method is often overridden to include relevant object properties in the output string. The example shows how to include 'statusCode' and 'error' properties in the string representation of an ApiException.

```dart
@override
String toString() {
  return 'ApiException{statusCode: $statusCode, error: $error}';
}
```

--------------------------------

### ITunesApi Constructor

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesApi-class

Initializes a new instance of the ITunesApi class.

```APIDOC
## `ITunesApi.new()`

### Description
Initializes a new instance of the ITunesApi class.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```dart
final iTunesHttpClient = ITunesHttpClient(); // Assuming ITunesHttpClient is defined elsewhere
final iTunesApi = ITunesApi.new(iTunesHttpClient);
```

### Response
#### Success Response (200)
N/A (Constructor)

#### Response Example
N/A (Constructor)
```

--------------------------------

### Initialize ITunesHttpClient - Dart

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesHttpClient/ITunesHttpClient

This snippet shows the Dart implementation for initializing the ITunesHttpClient. It takes an ITunesEnvironment, an optional http.Client, and a boolean for enabling logging. The constructor sets up an internal HTTP client and optionally enables logging to the console.

```dart
ITunesHttpClient(
  this.appStoreEnvironment,
  { 
  http.Client? client,
  bool loggingEnabled = false,
}
) : _loggingEnabled = loggingEnabled {
  _inner = client ?? http.Client();

  if (_loggingEnabled) {
    log.onRecord.listen((record) {
      print('${record.level.name}: ${record.time}: ${record.message}');
    });
  }
}
```

--------------------------------

### AppStoreEnvironment Constructors

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreEnvironment-class

This section details the constructors for creating AppStoreEnvironment instances, for both live and sandbox environments.

```APIDOC
## AppStoreEnvironment Constructors

### Description
Constructors for creating `AppStoreEnvironment` instances for live or sandbox environments.

### `AppStoreEnvironment.live`

#### Parameters
- **bundleId** (String) - Required - The app bundle ID.
- **issuerId** (String) - Required - The issuer ID.
- **keyId** (String) - Required - The private key ID.
- **privateKey** (String) - Required - The private key content.

### `AppStoreEnvironment.sandbox`

#### Parameters
- **bundleId** (String) - Required - The app bundle ID.
- **issuerId** (String) - Required - The issuer ID.
- **keyId** (String) - Required - The private key ID.
- **privateKey** (String) - Required - The private key content.
```

--------------------------------

### AppStoreServerHttpClient GET Request

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerHttpClient-class

Sends an HTTP GET request to a specified URL with optional headers. Returns a Future that completes with the Response object.

```dart
Future<Response> get(Uri url, {Map<String, String>? headers})
```

--------------------------------

### Create ITunesHttpClient Instance

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesHttpClient-class

Instantiates the ITunesHttpClient with the specified iTunes environment. Optionally, a custom HTTP client and logging can be configured.

```dart
final client = ITunesHttpClient.new(ITunesEnvironment.sandbox);
```

--------------------------------

### Create Live App Store Environment

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreEnvironment-class

Constructs an AppStoreEnvironment instance for the live Apple App Store. Requires bundle ID, issuer ID, key ID, and the private key for authentication.

```dart
AppStoreEnvironment.live({
  required String bundleId,
  required String issuerId,
  required String keyId,
  required String privateKey,
});
```

--------------------------------

### AppStoreEnvironment Methods

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreEnvironment-class

Details on the methods available for the AppStoreEnvironment class.

```APIDOC
## AppStoreEnvironment Methods

### Description
Methods available for the `AppStoreEnvironment` class.

### Methods
- **noSuchMethod**(Invocation invocation) → dynamic - Invoked when a nonexistent method or property is accessed.
- **toString**() → String - A string representation of this object.
```

--------------------------------

### ApiException Class Documentation

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ApiException-class

Detailed documentation for the ApiException class, covering its constructors, properties, and methods.

```APIDOC
## ApiException Class

### Description
Represents an exception that occurred during an API call, providing details about the status code and any associated error response.

### Implemented Types
* Exception

### Constructors
#### ApiException.new(int statusCode, {ApiError? error, String? response})
Creates a new ApiException.

* **statusCode** (int) - Required - The HTTP status code of the API response.
* **error** (ApiError?) - Optional - An ApiError object containing specific error details.
* **response** (String?) - Optional - The raw response string from the API.

### Properties
#### error → ApiError?

The ApiError object associated with the exception, if any.

#### statusCode → int

The HTTP status code returned by the API.

#### response → String?

The raw string response received from the API.

#### hashCode → int

The hash code for this object. (Inherited from Object)

#### runtimeType → Type

A representation of the runtime type of the object. (Inherited from Object)

### Methods
#### noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed. (Inherited from Object)

#### toString() → String
Returns a string representation of this object. (Overrides Object)

### Operators
#### operator ==(Object other) → bool
The equality operator. (Inherited from Object)
```

--------------------------------

### Get All Subscription Statuses (Dart)

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerAPI/getAllSubscriptionStatuses

Retrieves the statuses for all subscriptions associated with a customer's original transaction ID. This method requires the `originalTransactionId` as input and returns a `StatusResponse` object. It makes an HTTP GET request to the App Store Server API.

```dart
Future<StatusResponse> getAllSubscriptionStatuses( String originalTransactionId) async {
  var url = _appStoreServerHttpClient
      .getUrl('/inApps/v1/subscriptions/$originalTransactionId');

  var response = await _appStoreServerHttpClient.get(url);
  return StatusResponse.fromJson(jsonDecode(response.body));
}
```

--------------------------------

### AppStoreEnvironment Properties

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreEnvironment-class

Overview of the properties available on an AppStoreEnvironment instance.

```APIDOC
## AppStoreEnvironment Properties

### Description
Properties of the `AppStoreEnvironment` class.

### Properties
- **bundleId** (String) - The app bundle ID.
- **hashCode** (int) - The hash code for this object.
- **host** (String) - The live or sandbox host.
- **issuerId** (String) - The issuer ID.
- **keyId** (String) - The private key ID.
- **privateKey** (String) - The private key.
- **runtimeType** (Type) - A representation of the runtime type of the object.
```

--------------------------------

### Get Refund History (Dart)

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerAPI/getRefundHistory

Retrieves a list of all refunded in-app purchases for a customer using their original transaction ID. This method makes an HTTP GET request to the App Store Server API. It requires the original transaction ID as input and returns a RefundLookupResponse object.

```dart
Future<RefundLookupResponse> getRefundHistory(
    String originalTransactionId) async {
  var url = _appStoreServerHttpClient
      .getUrl('/inApps/v1/refund/lookup/$originalTransactionId');

  var response = await _appStoreServerHttpClient.get(url);
  return RefundLookupResponse.fromJson(jsonDecode(response.body));
}
```

--------------------------------

### Create URL with ITunesHttpClient

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesHttpClient-class

Constructs a fully qualified URL for the iTunes API based on the provided path and query parameters, using the client's configured environment.

```dart
Uri createApiUrl(String path, {Map<String, dynamic>? queryParameters}) {
  return iTunesHttpClient.getUrl(path, queryParameters: queryParameters);
}
```

--------------------------------

### Get Transaction History - Dart

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerAPI/getTransactionHistory

Retrieves a customer's in-app purchase transaction history for a given app using the original transaction ID. It handles optional revision parameters and makes an HTTP GET request to the App Store Server API. Dependencies include dart:convert for JSON decoding and a custom _appStoreServerHttpClient.

```dart
Future<HistoryResponse> getTransactionHistory(String originalTransactionId,
    {String? revision}) async {
  var url = _appStoreServerHttpClient.getUrl(
      '/inApps/v1/history/$originalTransactionId',
      queryParameters: revision != null ? {'revision': revision} : null);

  var response = await _appStoreServerHttpClient.get(url);
  return HistoryResponse.fromJson(jsonDecode(response.body));
}
```

--------------------------------

### Create Sandbox App Store Environment

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreEnvironment-class

Constructs an AppStoreEnvironment instance for the sandbox Apple App Store. Requires bundle ID, issuer ID, key ID, and the private key for authentication.

```dart
AppStoreEnvironment.sandbox({
  required String bundleId,
  required String issuerId,
  required String keyId,
  required String privateKey,
});
```

--------------------------------

### HistoryResponse Class Documentation

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/HistoryResponse-class

Provides details about the HistoryResponse class, its constructors, properties, and methods.

```APIDOC
## HistoryResponse Class

A response that contains the customer’s transaction history for an app.

### Properties

- **environment** (String) - The server environment in which you’re making the request, whether sandbox or production.
- **appAppleId** (int?) - The app's identifier in the App Store.
- **bundleId** (String) - The bundle identifier of the app.
- **hasMore** (bool) - A Boolean value that indicates whether the App Store has more transactions than are returned in this request.
- **revision** (String) - A token you use in a query to request the next set of transactions from the Get Transaction History endpoint.
- **signedTransactions** (List<String>) - An array of in-app purchase transactions for the customer, signed by Apple, in JSON Web Signature format.

### Methods

- **toJson()** - Returns a JSON representation of the HistoryResponse object.
- **toString()** - Returns a string representation of the HistoryResponse object.

### Constructors

- **HistoryResponse.new(String environment, int? appAppleId, String bundleId, bool hasMore, String revision, List<String> signedTransactions)**
- **HistoryResponse.fromJson(Map<String, dynamic> json)**
```

--------------------------------

### Read Response Body as String with ITunesHttpClient

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesHttpClient-class

Retrieves the response body of an HTTP GET request as a String. This is useful for APIs that return text-based data.

```dart
Future<String> readResponseAsString(Uri url, {Map<String, String>? headers}) async {
  final responseBody = await iTunesHttpClient.read(url, headers: headers);
  return responseBody;
}
```

--------------------------------

### AppStoreEnvironment Operators

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreEnvironment-class

Information on the operators supported by the AppStoreEnvironment class.

```APIDOC
## AppStoreEnvironment Operators

### Description
Operators supported by the `AppStoreEnvironment` class.

### Operators
- **operator ==**(Object other) → bool - The equality operator.
```

--------------------------------

### JWSRenewalInfoDecodedPayload Constructor

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/JWSRenewalInfoDecodedPayload-class

Demonstrates the instantiation of the JWSRenewalInfoDecodedPayload class using its various constructors. This includes the main constructor for direct initialization, a factory constructor for creating an instance from an encoded payload string, and another factory constructor for creating an instance from a JSON map.

```dart
JWSRenewalInfoDecodedPayload renewalInfo = JWSRenewalInfoDecodedPayload.new(
  'autoRenewProductId',
  1, // autoRenewStatus
  null, // expirationIntent
  null, // gracePeriodExpiresDate
  false, // isInBillingRetryPeriod
  null, // offerIdentifier
  null, // offerType
  'originalTransactionId',
  null, // priceIncreaseStatus
  'productId',
  1678886400000 // signedDate (Unix timestamp in milliseconds)
);

// Example using fromEncodedPayload (if you have a raw payload string)
// JWSRenewalInfoDecodedPayload decodedInfo = JWSRenewalInfoDecodedPayload.fromEncodedPayload('your_encoded_payload_string');

// Example using fromJson (if you have a JSON map)
// Map<String, dynamic> jsonPayload = {
//   'autoRenewProductId': 'com.example.product1',
//   'autoRenewStatus': 1,
//   'originalTransactionId': '1234567890',
//   'productId': 'com.example.product1',
//   'signedDate': 1678886400000
// };
// JWSRenewalInfoDecodedPayload jsonInfo = JWSRenewalInfoDecodedPayload.fromJson(jsonPayload);
```

--------------------------------

### GET /inApps/v1/history/{originalTransactionId}

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerAPI/getTransactionHistory

Retrieves a customer's in-app purchase transaction history for your app using the original transaction ID.

```APIDOC
## GET /inApps/v1/history/{originalTransactionId}

### Description
Get a customer’s in-app purchase transaction history for your app.

### Method
GET

### Endpoint
/inApps/v1/history/{originalTransactionId}

### Parameters
#### Path Parameters
- **originalTransactionId** (String) - Required - The original transaction identifier of any transaction belonging to the customer.

#### Query Parameters
- **revision** (String) - Optional - The revision of the App Store Server API to use.

### Request Example
```json
{
  "example": "Not applicable for GET request"
}
```

### Response
#### Success Response (200)
- **revision** (String) - The revision of the App Store Server API.
- **hasMore** (Boolean) - Indicates if there are more transactions available.
- **items** (Array) - An array of transaction history items.
  - **transactionId** (String) - The unique identifier for the transaction.
  - **productId** (String) - The identifier of the product that was purchased.
  - **purchaseDate** (String) - The date and time of the purchase.
  - **quantity** (Integer) - The number of in-app purchases.
  - **type** (String) - The type of the transaction.
  - **environment** (String) - The environment in which the purchase was made.
  - **bundleId** (String) - The bundle identifier of the app.
  - **transactionReason** (String) - The reason for the transaction.
  - **originalTransactionId** (String) - The original transaction identifier.

#### Response Example
```json
{
  "revision": "2",
  "hasMore": true,
  "items": [
    {
      "transactionId": "1000000123456789",
      "productId": "com.example.consumable.gems",
      "purchaseDate": "2023-01-01T10:00:00Z",
      "quantity": 1,
      "type": "Purchase",
      "environment": "Sandbox",
      "bundleId": "com.example.app",
      "transactionReason": "Purchase",
      "originalTransactionId": "1000000123456789"
    }
  ]
}
```
```

--------------------------------

### ITunesHttpClient Methods

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesHttpClient-class

This section details the available HTTP methods for making requests to the iTunes API using the ITunesHttpClient.

```APIDOC
## DELETE /<url>

### Description
Sends an HTTP DELETE request with the given headers to the specified URL.

### Method
DELETE

### Endpoint
`Uri url`

### Parameters
#### Path Parameters
- **url** (Uri) - Required - The URL to send the DELETE request to.

#### Query Parameters
None

#### Request Body
- **body** (Object?) - Optional - The request body.
- **headers** (Map<String, String>?) - Optional - Headers to include in the request.
- **encoding** (Encoding?) - Optional - The encoding for the request body.

### Request Example
```json
{
  "url": "https://example.com/api/resource",
  "headers": {"Authorization": "Bearer YOUR_TOKEN"},
  "body": {"key": "value"}
}
```

### Response
#### Success Response (200)
- **Response** (Response) - The HTTP response object.

#### Response Example
```json
{
  "statusCode": 200,
  "body": "{\"message\": \"Resource deleted\"}"
}
```

## GET /<url>

### Description
Sends an HTTP GET request with the given headers to the specified URL.

### Method
GET

### Endpoint
`Uri url`

### Parameters
#### Path Parameters
- **url** (Uri) - Required - The URL to send the GET request to.

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "url": "https://example.com/api/resource",
  "headers": {"Authorization": "Bearer YOUR_TOKEN"}
}
```

### Response
#### Success Response (200)
- **Response** (Response) - The HTTP response object.

#### Response Example
```json
{
  "statusCode": 200,
  "body": "{\"data\": \"some value\"}"
}
```

## POST /<url>

### Description
Sends an HTTP POST request with the given headers and body to the specified URL.

### Method
POST

### Endpoint
`Uri url`

### Parameters
#### Path Parameters
- **url** (Uri) - Required - The URL to send the POST request to.

#### Query Parameters
None

#### Request Body
- **body** (Object?) - Optional - The request body.
- **headers** (Map<String, String>?) - Optional - Headers to include in the request.
- **encoding** (Encoding?) - Optional - The encoding for the request body.

### Request Example
```json
{
  "url": "https://example.com/api/resource",
  "headers": {"Authorization": "Bearer YOUR_TOKEN"},
  "body": {"key": "value"}
}
```

### Response
#### Success Response (200)
- **Response** (Response) - The HTTP response object.

#### Response Example
```json
{
  "statusCode": 201,
  "body": "{\"message\": \"Resource created\"}"
}
```

## PUT /<url>

### Description
Sends an HTTP PUT request with the given headers and body to the specified URL.

### Method
PUT

### Endpoint
`Uri url`

### Parameters
#### Path Parameters
- **url** (Uri) - Required - The URL to send the PUT request to.

#### Query Parameters
None

#### Request Body
- **body** (Object?) - Optional - The request body.
- **headers** (Map<String, String>?) - Optional - Headers to include in the request.
- **encoding** (Encoding?) - Optional - The encoding for the request body.

### Request Example
```json
{
  "url": "https://example.com/api/resource/123",
  "headers": {"Authorization": "Bearer YOUR_TOKEN"},
  "body": {"key": "updated_value"}
}
```

### Response
#### Success Response (200)
- **Response** (Response) - The HTTP response object.

#### Response Example
```json
{
  "statusCode": 200,
  "body": "{\"message\": \"Resource updated\"}"
}
```

## PATCH /<url>

### Description
Sends an HTTP PATCH request with the given headers and body to the specified URL.

### Method
PATCH

### Endpoint
`Uri url`

### Parameters
#### Path Parameters
- **url** (Uri) - Required - The URL to send the PATCH request to.

#### Query Parameters
None

#### Request Body
- **body** (Object?) - Optional - The request body.
- **headers** (Map<String, String>?) - Optional - Headers to include in the request.
- **encoding** (Encoding?) - Optional - The encoding for the request body.

### Request Example
```json
{
  "url": "https://example.com/api/resource/123",
  "headers": {"Authorization": "Bearer YOUR_TOKEN"},
  "body": {"key": "partially_updated_value"}
}
```

### Response
#### Success Response (200)
- **Response** (Response) - The HTTP response object.

#### Response Example
```json
{
  "statusCode": 200,
  "body": "{\"message\": \"Resource patched\"}"
}
```

## GET /<url>/read

### Description
Sends an HTTP GET request with the given headers to the specified URL and returns the response body as a String.

### Method
GET

### Endpoint
`Uri url`

### Parameters
#### Path Parameters
- **url** (Uri) - Required - The URL to send the GET request to.

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "url": "https://example.com/api/resource/123",
  "headers": {"Authorization": "Bearer YOUR_TOKEN"}
}
```

### Response
#### Success Response (200)
- **String** (String) - The response body as a String.

#### Response Example
```json
"{\"data\": \"some value\"}"
```

## GET /<url>/readBytes

### Description
Sends an HTTP GET request with the given headers to the specified URL and returns the response body as a list of bytes.

### Method
GET

### Endpoint
`Uri url`

### Parameters
#### Path Parameters
- **url** (Uri) - Required - The URL to send the GET request to.

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "url": "https://example.com/api/resource/binary",
  "headers": {"Authorization": "Bearer YOUR_TOKEN"}
}
```

### Response
#### Success Response (200)
- **Uint8List** (Uint8List) - The response body as a list of bytes.

#### Response Example
```json
"[10, 20, 30, 40]" 
```

## Utility Functions

### `getUrl(String path, {Map<String, dynamic>? queryParameters})`

#### Description
Creates a URL with the given path and currently configured environment.

#### Method
Utility

#### Endpoint
N/A

#### Parameters
- **path** (String) - Required - The path for the URL.
- **queryParameters** (Map<String, dynamic>?) - Optional - Query parameters to append to the URL.

#### Request Example
```json
{
  "path": "/v1/products",
  "queryParameters": {"limit": 10}
}
```

#### Response
#### Success Response
- **Uri** (Uri) - The constructed URL.

#### Response Example
```json
"https://api.example.com/v1/products?limit=10"
```

### `close()`

#### Description
Closes the client and cleans up any resources associated with it.

#### Method
Utility

#### Endpoint
N/A

#### Parameters
None

#### Request Example
None

#### Response
#### Success Response
- **void** - This method does not return a value.

#### Response Example
None
```

--------------------------------

### Read Response Body as Bytes with ITunesHttpClient

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesHttpClient-class

Fetches the response body of an HTTP GET request as a list of bytes (Uint8List). Ideal for handling binary data like images or files.

```dart
Future<Uint8List> readResponseAsBytes(Uri url, {Map<String, String>? headers}) async {
  final responseBytes = await iTunesHttpClient.readBytes(url, headers: headers);
  return responseBytes;
}
```

--------------------------------

### AppStoreServerHttpClient Constructor

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerHttpClient-class

Initializes an AppStoreServerHttpClient instance. It requires an AppStoreEnvironment and can optionally be configured with a client, JWT, a JWT update callback, and logging enablement.

```dart
AppStoreServerHttpClient.new(AppStoreEnvironment appStoreEnvironment, {Client? client, String? jwt, dynamic jwtTokenUpdatedCallback(String)?, bool loggingEnabled = false})
```

--------------------------------

### JWSTransactionDecodedPayload toJson Example

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/JWSTransactionDecodedPayload-class

Shows how to convert a JWSTransactionDecodedPayload object back into a JSON-compatible map. This is essential for sending transaction data in requests or for serialization purposes. The `toJson` method is implicitly called by the `@JsonSerializable()` annotation.

```dart
final Map<String, dynamic> transactionJson = transactionPayload.toJson();

print(transactionJson);
```

--------------------------------

### POST Method

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesHttpClient/post

Sends an HTTP POST request with the given headers and body to the specified URL.

```APIDOC
## POST / 

### Description
Sends an HTTP POST request with the given headers and body to the given URL.

### Method
POST

### Endpoint
/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **headers** (Map<String, String>?): Optional - Headers for the request.
- **body** (Object?): Optional - The body of the request. Can be a String, List<int>, or Map<String, String>.
- **encoding** (Encoding?): Optional - The encoding to use for the body. Defaults to utf8.

### Request Example
```json
{
  "url": "http://example.com/data",
  "headers": {
    "Content-Type": "application/json"
  },
  "body": {
    "key": "value"
  }
}
```

### Response
#### Success Response (200)
- **response** (http.Response) - The response from the server.

#### Response Example
```json
{
  "statusCode": 200,
  "body": "{\"message\": \"Success\"}",
  "headers": {
    "Content-Type": "application/json"
  }
}
```
```

--------------------------------

### ExtendRenewalDateResponse Class Documentation

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ExtendRenewalDateResponse-class

Details about the ExtendRenewalDateResponse class, including its constructors, properties, and methods.

```APIDOC
## ExtendRenewalDateResponse Class

### Description
A response that indicates whether the renewal-date extension succeeded and related details.

### Constructors

#### `ExtendRenewalDateResponse.new(String effectiveDate, String originalTransactionId, bool success, String webOrderLineItemId)`

Creates a new `ExtendRenewalDateResponse` object.

#### `ExtendRenewalDateResponse.fromJson(Map<String, dynamic> json)`

Factory constructor to create an `ExtendRenewalDateResponse` from a JSON map.

### Properties

- **effectiveDate** (String) - The date that the successful subscription-renewal extension begins.
- **originalTransactionId** (String) - The original transaction identifier of the subscription that experienced a service interruption.
- **success** (bool) - A Boolean value that indicates whether the subscription-renewal-date extension succeeded.
- **webOrderLineItemId** (String) - A unique ID that identifies subscription-purchase events including subscription renewals, across devices.

### Methods

- **toJson() → Map<String, dynamic>**
  Converts the `ExtendRenewalDateResponse` object to a JSON map.

- **toString() → String**
  Returns a string representation of this object.

### Operators

- **operator ==(Object other) → bool**
  The equality operator.
```

--------------------------------

### POST /

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerHttpClient/post

Sends an HTTP POST request with the given headers and body to the specified URL.

```APIDOC
## POST /

### Description
Sends an HTTP POST request with the given headers and body to the given URL.

### Method
POST

### Endpoint
/

### Parameters
#### Query Parameters
- **url** (Uri) - Required - The URL to send the request to.
- **headers** (Map<String, String>) - Optional - The headers for the request.
- **body** (Object) - Optional - The body of the request. Can be a String, List<int>, or Map<String, String>.
- **encoding** (Encoding) - Optional - The encoding to use for the body. Defaults to utf8.

### Request Example
```json
{
  "url": "http://example.com/data",
  "headers": {
    "Content-Type": "application/json"
  },
  "body": {
    "key": "value"
  }
}
```

### Response
#### Success Response (200)
- **response** (Response) - The HTTP response object.

#### Response Example
```json
{
  "statusCode": 200,
  "body": "{ \"message\": \"Success\" }"
}
```
```

--------------------------------

### VerifyReceiptResponse toJson Method

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/VerifyReceiptResponse-class

Shows how to convert a VerifyReceiptResponse object back into a JSON-compatible Map. This method is useful when you need to serialize the response object, for example, to store it or send it to another service. The output map's keys are designed to match the expected JSON format for receipt verification responses.

```dart
final Map<String, dynamic> jsonMap = receiptResponse.toJson();
```

--------------------------------

### Implement readBytes Method (Dart)

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerHttpClient/readBytes

This implementation of the readBytes method sends an HTTP GET request to a specified URL with optional headers. It returns the response body as a Uint8List and throws a ClientException if the HTTP response status code is not successful. This method is part of the App Store Server SDK.

```dart
@override
Future<Uint8List> readBytes(Uri url, {Map<String, String>? headers}) async {
  final response = await get(url, headers: headers);
  _checkResponseSuccess(url, response);
  return response.bodyBytes;
}
```

--------------------------------

### verifyReceipt

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesApi-class

Sends a receipt to the App Store for verification.

```APIDOC
## `verifyReceipt`

### Description
Send a receipt to the App Store for verification.

### Method
`Future<VerifyReceiptResponse> verifyReceipt({required String password, required String receiptData, bool excludeOldTransactions = true})`

### Endpoint
N/A (Method within a class)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **password** (String) - Required - The password for the App Store.
- **receiptData** (String) - Required - The receipt data to verify.
- **excludeOldTransactions** (bool) - Optional - Whether to exclude old transactions. Defaults to true.
```

--------------------------------

### AppStoreServerHttpClient Constructor (Dart)

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/AppStoreServerHttpClient/AppStoreServerHttpClient

This Dart constructor initializes the AppStoreServerHttpClient. It accepts an AppStoreEnvironment, an optional HTTP client, a JWT string, a callback for JWT updates, and a boolean to enable logging. The implementation sets up internal variables and an optional logging listener.

```dart
AppStoreServerHttpClient(
  1. AppStoreEnvironment appStoreEnvironment, {
  2. Client? client, 
  3. String? jwt, 
  4. dynamic jwtTokenUpdatedCallback(
    1. String
)?,
  5. bool loggingEnabled = false,

})

AppStoreServerHttpClient(this.appStoreEnvironment,
    {http.Client? client,
    String? jwt,
    Function(String)? jwtTokenUpdatedCallback,
    bool loggingEnabled = false})
    : _jwtTokenUpdatedCallback = jwtTokenUpdatedCallback,
      _loggingEnabled = loggingEnabled {
  _inner = client ?? http.Client();

  if (_loggingEnabled) {
    log.onRecord.listen((record) {
      print('${record.level.name}: ${record.time}: ${record.message}');
    });
  }
}
```

--------------------------------

### Dart: JWSRenewalInfoDecodedPayload Constructor Implementation

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/JWSRenewalInfoDecodedPayload/JWSRenewalInfoDecodedPayload

This code snippet shows the Dart implementation of the JWSRenewalInfoDecodedPayload constructor. It initializes the class with various renewal-related parameters required for processing App Store subscription information.

```dart
const JWSRenewalInfoDecodedPayload(
    this.autoRenewProductId,
    this.autoRenewStatus,
    this.expirationIntent,
    this.gracePeriodExpiresDate,
    this.isInBillingRetryPeriod,
    this.offerIdentifier,
    this.offerType,
    this.originalTransactionId,
    this.priceIncreaseStatus,
    this.productId,
    this.signedDate);

```

--------------------------------

### Implement verifyReceipt Method (Dart)

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesApi/verifyReceipt

This Dart implementation demonstrates how to use the verifyReceipt method. It constructs a VerifyReceiptRequest, sends it to the App Store's verification URL using an HTTP client, and parses the JSON response into a VerifyReceiptResponse object. Dependencies include JSON encoding/decoding and an HTTP client abstraction.

```dart
Future<VerifyReceiptResponse> verifyReceipt({
  required String password,
  required String receiptData,
  bool excludeOldTransactions = true,
}) async {
  var request = VerifyReceiptRequest(
      password: password,
      receiptData: receiptData,
      excludeOldTransactions: excludeOldTransactions);

  var url = _iTunesHttpClient.getUrl('/verifyReceipt');

  var response = 
      await _iTunesHttpClient.post(url, body: jsonEncode(request.toJson()));

  return VerifyReceiptResponse.fromJson(jsonDecode(response.body));
}
```

--------------------------------

### VerifyReceiptResponse Constructor and JSON Parsing

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/VerifyReceiptResponse-class

Demonstrates how to instantiate the VerifyReceiptResponse class using its named constructors. `VerifyReceiptResponse.new` is used for creating instances with all provided data, while `VerifyReceiptResponse.fromJson` is used for parsing JSON data into a VerifyReceiptResponse object. This is crucial for handling responses from external services.

```dart
final receiptResponse = VerifyReceiptResponse.new(
  status: 0,
  environment: 'Production',
  receipt: Receipt(...),
  latestReceiptInfo: [ReceiptInfo(...)],
  latestReceipt: 'base64encodedreceipt',
  pendingRenewalInfo: [PendingRenewalInfo(...)],
);

final jsonResponse = {
  'status': 0,
  'environment': 'Production',
  'receipt': receiptJson,
  'latest_receipt_info': [receiptInfoJson],
  'latest_receipt': 'base64encodedreceipt',
  'pending_renewal_info': [pendingRenewalInfoJson],
};
final parsedResponse = VerifyReceiptResponse.fromJson(jsonResponse);
```

--------------------------------

### SubscriptionGroupIdentifierItem Constructor and Methods (Dart)

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/SubscriptionGroupIdentifierItem-class

Demonstrates the creation and usage of the SubscriptionGroupIdentifierItem class in Dart. It includes constructors for direct instantiation and from JSON, along with methods for converting to JSON and string representation.

```dart
class SubscriptionGroupIdentifierItem {
  final String subscriptionGroupIdentifier;
  final List<LastTransactionsItem> lastTransactions;

  SubscriptionGroupIdentifierItem.new(this.subscriptionGroupIdentifier, this.lastTransactions);

  const SubscriptionGroupIdentifierItem.fromJson(Map<String, dynamic> json) :
      subscriptionGroupIdentifier = json['subscriptionGroupIdentifier'],
      lastTransactions = const []; // Placeholder, actual parsing needed

  Map<String, dynamic> toJson() {
    return {
      'subscriptionGroupIdentifier': subscriptionGroupIdentifier,
      'lastTransactions': lastTransactions.map((e) => e.toJson()).toList(),
    };
  }

  @override
  String toString() {
    return 'SubscriptionGroupIdentifierItem(subscriptionGroupIdentifier: $subscriptionGroupIdentifier, lastTransactions: $lastTransactions)';
  }
}
```

--------------------------------

### ApiException Methods (Dart)

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ApiException-class

Describes the methods available for the ApiException class, including noSuchMethod and toString.

```dart
noSuchMethod(Invocation invocation) → dynamic

tostring() → String
```

--------------------------------

### HTTP POST Request with ITunesHttpClient

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ITunesHttpClient-class

Sends an HTTP POST request to a specified URL with optional headers, body, and encoding. Useful for submitting data to the iTunes API.

```dart
Future<Response> postRequest(Uri url, {Object? body, Map<String, String>? headers}) async {
  final response = await iTunesHttpClient.post(url, body: body, headers: headers);
  return response;
}
```

--------------------------------

### ReceiptInfo Constructor - Dart

Source: https://pub.dev/documentation/app_store_server_sdk/latest/app_store_server_sdk/ReceiptInfo-class

The default constructor for the ReceiptInfo class allows for the initialization of various receipt-related properties. It is part of the App Store Server SDK for Dart.

```dart
ReceiptInfo.new({
  String? cancellationDate,
  String? cancellationDateMs,
  String? cancellationDatePst,
  String? cancellationReason,
  String? quantity,
  String? productId,
  String? transactionId,
  String? originalTransactionId,
  String? purchaseDate,
  String? purchaseDateMs,
  String? purchaseDatePst,
  String? originalPurchaseDate,
  String? originalPurchaseDateMs,
  String? originalPurchaseDatePst,
  String? expiresDate,
  String? expiresDateMs,
  String? expiresDatePst,
  String? webOrderLineItemId,
  String? isTrialPeriod,
  String? isInIntroOfferPeriod,
  String? inAppOwnershipType,
  String? subscriptionGroupIdentifier,
})

```

--------------------------------

### iTunes API

Source: https://pub.dev/documentation/app_store_server_sdk/latest/index

The iTunes API includes endpoints for verifying receipt information.

```APIDOC
## iTunes API

### Description
Provides functionality to verify receipts.

### Endpoints

*   **Verify receipt**
    *   **Method**: POST
    *   **Endpoint**: `/verifyReceipt`
    *   **Description**: Verifies the receipt data with Apple's servers.
```
Tokens:
Raw