---
title: "POST /user/StartProductSubscription"
method: POST
path: "/user/StartProductSubscription"
---

# POST /user/StartProductSubscription

`POST /user/StartProductSubscription`

Starts a product subscription for a user with the specified identity provider.

Your estimated bill for charges on the number of users and related costs will take 48 hours to appear for billing periods that haven't closed (marked as **Pending** billing status) in Amazon Web Services Billing. For more information, see [Viewing your monthly charges](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/invoice.html) in the _Amazon Web Services Billing User Guide_.

## Request body

- object
  - `Username` string, required — The user name from the identity provider of the user.
  - `IdentityProvider` object, required — Refers to an identity provider.
    - `ActiveDirectoryIdentityProvider` object — The <code>ActiveDirectoryIdentityProvider</code> resource contains settings and other details about a specific Active Directory identity provider.
      - `DirectoryId` string — The directory ID for an Active Directory identity provider.
      - `ActiveDirectorySettings` object — The <code>ActiveDirectorySettings</code> resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
        - `DomainName` string — The domain name for the Active Directory.
        - `DomainIpv4List` IpV4[] — A list of domain IPv4 addresses that are used for the Active Directory.
        - `DomainIpv6List` IpV6[] — A list of domain IPv6 addresses that are used for the Active Directory.
        - `DomainCredentialsProvider` object — Points to the <code>CredentialsProvider</code> resource that contains information about the credential provider for user administration.
          - `SecretsManagerCredentialsProvider` object — Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
            - `SecretId` string — The ID of the Secrets Manager secret that contains credentials.
        - `DomainNetworkSettings` object — The <code>DomainNetworkSettings</code> resource contains an array of subnets that apply for the Active Directory.
          - `Subnets` Subnet[], required — Contains a list of subnets that apply for the Active Directory domain.
      - `ActiveDirectoryType` 'SELF_MANAGED' | 'AWS_MANAGED' — The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
      - `IsSharedActiveDirectory` boolean — Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
  - `Product` string, required — <p>The name of the user-based subscription product.</p> <p>Valid values: <code>VISUAL_STUDIO_ENTERPRISE</code> | <code>VISUAL_STUDIO_PROFESSIONAL</code> | <code>OFFICE_PROFESSIONAL_PLUS</code> | <code>REMOTE_DESKTOP_SERVICES</code> </p>
  - `Domain` string — The domain name of the Active Directory that contains the user for whom to start the product subscription.
  - `Tags` object — The tags that apply to the product subscription.

## Response `200`

Success

- StartProductSubscriptionResponse
  - `ProductUserSummary` object, required — Metadata that describes the start product subscription operation.
    - `Username` string, required — The user name from the identity provider for this product user.
    - `Product` string, required — The name of the user-based subscription product.
    - `IdentityProvider` object, required — An object that specifies details for the identity provider.
      - `ActiveDirectoryIdentityProvider` object — The <code>ActiveDirectoryIdentityProvider</code> resource contains settings and other details about a specific Active Directory identity provider.
        - `DirectoryId` string — The directory ID for an Active Directory identity provider.
        - `ActiveDirectorySettings` object — The <code>ActiveDirectorySettings</code> resource contains details about the Active Directory, including network access details such as domain name and IP addresses, and the credential provider for user administration.
          - `DomainName` string — The domain name for the Active Directory.
          - `DomainIpv4List` IpV4[] — A list of domain IPv4 addresses that are used for the Active Directory.
          - `DomainIpv6List` IpV6[] — A list of domain IPv6 addresses that are used for the Active Directory.
          - `DomainCredentialsProvider` object — Points to the <code>CredentialsProvider</code> resource that contains information about the credential provider for user administration.
            - `SecretsManagerCredentialsProvider` object — Identifies the Secrets Manager secret that contains credentials needed for user administration in the Active Directory.
              - …
          - `DomainNetworkSettings` object — The <code>DomainNetworkSettings</code> resource contains an array of subnets that apply for the Active Directory.
            - `Subnets` Subnet[], required — Contains a list of subnets that apply for the Active Directory domain.
        - `ActiveDirectoryType` 'SELF_MANAGED' | 'AWS_MANAGED' — The type of Active Directory – either a self-managed Active Directory or an Amazon Web Services Managed Active Directory.
        - `IsSharedActiveDirectory` boolean — Whether this directory is shared from an Amazon Web Services Managed Active Directory. The default value is false.
    - `Status` string, required — The status of a product for this user.
    - `ProductUserArn` string — The Amazon Resource Name (ARN) for this product user.
    - `StatusMessage` string — The status message for a product for this user.
    - `Domain` string — The domain name of the Active Directory that contains the user information for the product subscription.
    - `SubscriptionStartDate` string — The start date of a subscription.
    - `SubscriptionEndDate` string — The end date of a subscription.

## Other responses

- `480` — ServiceQuotaExceededException
- `481` — ValidationException
- `482` — ConflictException
- `483` — ThrottlingException
- `484` — InternalServerException
- `485` — ResourceNotFoundException
- `486` — AccessDeniedException

---

[API](https://skmtc.net/aws/apis/license-manager-user-subscriptions.md) · [All operations](https://skmtc.net/aws/apis/license-manager-user-subscriptions/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/license-manager-user-subscriptions/versions/3f333914dcdb/schema)
